openapi.json•4.43 MB
{
"openapi": "3.0.0",
"info": {
"title": "Confluent Cloud APIs",
"version": "",
"x-api-id": "46234552-5833-42eb-ba0f-883ad3f70d2b",
"x-audience": "external-public",
"x-logo": {
"url": "https://assets.confluent.io/m/1661ef5e4ff82d3d/"
},
"description": "# Introduction\n\n<div class=\"status-info\">\n<p class=\"status-info-title\">Note</p>\nThis documents the collection of Confluent Cloud APIs. Each API documents its\n<a href=\"#section/Versioning/API-Lifecycle-Policy\">lifecycle phase</a>. APIs\nmarked as Early Access or Preview are not ready for production usage. We're currently\nworking with a select group of customers to get feedback and iterate on these APIs.\n</div>\n\nConfluent Cloud APIs are a core building block of Confluent Cloud. You can use the APIs to\nmanage your own account or to integrate Confluent into your product.\n\nMost of the APIs are organized around\n<a href=\"http://en.wikipedia.org/wiki/Representational_State_Transfer\" target=\"_blank\">REST</a>\nand the resources which make up Confluent Cloud. The APIs have predictable\nresource-oriented URLs, transport data using JSON, and use standard HTTP verbs,\nresponse codes, authentication, and design principles.\n\n# Object Model\n\n<div class=\"status-info\">\n<p class=\"status-info-title\">Note</p>\nThis section describes the object model for many Confluent Cloud APIs, but not all.\nThe Connect v1 API group has a different object model. You can review the example\nrequest and response bodies in <a href=\"#tag/Connectors-(v1)\">Connect v1 API</a>\nto see its object model.\n</div>\n\nConfluent Cloud APIs are primarily designed to be declarative and intent-oriented. In other words, \ntell the API what you want (for example, throughput or SLOs) and it will figure out how to make it happen \n(for example, cluster sizing). A Confluent object acts as a \"record of intent\" — after you create the\nobject, Confluent Cloud will work tirelessly in the background to ensure that the object exists\nas specified.\n\nConfluent APIs represent objects in JSON with media-type `application/json`.\n\nMany objects follow a model consisting of `spec` and `status`. An object's `spec` tells\nConfluent the _desired state_ (specification) of the resource. The object may not be\nimmediately available or changes may not be immediately applied. For this reason,\nmany objects also have a `status` property that provides info about the\n_current state_ of the resource. Confluent Cloud is continuously and actively managing\neach resource's current state to match it's desired state.\n\nAll Confluent objects share a set of common properties:\n\n* **api_version** – API objects have an `api_version` field indicating their API version.\n* **kind** – API objects have a `kind` field indicating the kind of object it is.\n* **id** – Each object in the API will have an identifier, indicated via its `id` field,\n and should be treated as an opaque string unless otherwise specified.\n\nThere are a number of other [standard properties](#standard-properties) and that you'll encounter\nused by many API objects. And of course, objects have plenty of non-standard fields that are\nspecific to each object _kind_... this is what makes them interesting!\n\n# Authentication\n\nConfluent uses API keys and JSON Web Tokens (JWTs) to integrate your applications\nand workflows to your Confluent Cloud resources using the Confluent Cloud REST APIs.\nYour applications and workflows must be authenticated and authorized in order to\naccess and manage Confluent Cloud resources.\n\n## API keys\n\nYou can create and manage your API keys using the Confluent Cloud Console or\nConfluent 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).\n\nConfluent Cloud uses the following two categories of API keys:\n\n* A **Cloud API key** grants access to the Confluent Cloud Management APIs,\n such as for Provisioning and Metrics integrations.\n* A **resource-specific API key** grants access to a Confluent Kafka cluster\n (Kafka API key), a Confluent Cloud Schema Registry (Schema Registry API key),\n Flink (Flink API key scoped to an Environment + Region pair), or a ksqlDB application.\n\nEach Confluent Cloud API key is associated with a principal (specific user or\nservice account) and inherits the permissions granted to the owner.\n\n* For example, if service account `Armageddon` is granted ACLs on Kafka cluster\n `neptune`, then a Kafka API Key for `neptune` owned by `Armageddon` will have\n these ACLs enforced.\n* **Note:** API keys are automatically deleted when the associated user or service\n account is deleted (for example, when an employee leaves the company or moves to\n a new department and an SSO integration removes the Confluent Cloud user as they\n no longer require access).\n* Confluent **strongly recommends** that you use service accounts for all\n production-critical access.\n\nConfluent Cloud API keys grant access to Confluent Cloud resources, so **keep them secure**!\nDo not share your API keys and secrets in publicly-accessible locations, such as \nGitHub or client-side code.\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail.\nAPI requests without authentication will also fail.\n\nTo use an API key, you must send it in an `Authorization: Basic {credentials}` header.\nRemember that HTTP Basic authentication requires you to provide your credentials as\nthe API key ID and associated API secret separated by a colon and encoded using Base64\nformat. For example, if your API key ID is `ABCDEFGH123456789` and the API key Secret \nis `XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO`, then the authorization header is:\n\n```text\nAuthorization: Basic QUJDREVGR0gxMjM0NTY3ODk6WE5DSVc5M0kyTDFTUVBKU0o4MjNLMUxTOTAyS0xERk1DWlBXRU8=\n```\n\nYou can generate this header example from the API key:\n\nmacOS:\n\n```shell\n$ echo -n \"ABCDEFGH123456789:XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO\" | base64\n\n```\n\nLinux:\n\n```shell\n$ echo -n \"ABCDEFGH123456789:XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO\" | base64 -w 0\n```\n\nTo find out if an API operation supports Cloud API Keys, look in the **AUTHORIZATIONS**\nlisting for `cloud-api-key`.\n\nTo find out if an API operation supports resource-specific API Keys, look in the **AUTHORIZATIONS**\nlisting for `resource-api-key`.\n\n## External OAuth\n\nYou can use [OAuth/OIDC support for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html)\nto authenticate and authorize access to applications and workloads for the\nfollowing Confluent Cloud REST APIs:\n\n* **Kafka REST API**: [Kafka REST API for Clusters(V3)](https://docs.confluent.io/cloud/current/api.html#tag/Cluster-(v3)).\n 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).\n* **Schema Registry REST API**: [Schema Registry REST API for Schemas(V1)](https://docs.confluent.io/cloud/current/api.html#tag/Schemas-(v1))\n and [Subjects](https://docs.confluent.io/cloud/current/api.html#tag/Subjects-(v1)).\n 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).\n\nAlternatively, to find out if an API operation supports external tokens, look in the **AUTHORIZATIONS**\nlisting for `external-access-token`.\n\n## Confluent STS tokens\n\nConfluent Security Token Service (STS) issues access tokens (`confluent-sts-access-token`)\nby exchanging an external token (`external-access-token`) for a `confluent-sts-access-token`. You can use\nConfluent STS tokens to authenticate to Confluent Cloud APIs that support the\n`confluent-sts-access-token` notation.\n\nTo find out if an API operation supports Confluent STS tokens, look in the **AUTHORIZATIONS**\nlisting for `confluent-sts-access-token`.\n\n## Partner OAuth\n\nApproved partners can fetch Partner tokens (`confluent-partner-access-token`) that validate their identity\nand grant access to the Partner API (`partner/v2`), which lets them sign up\nan organization on behalf of a customer, manage entitlements (create, read, and list),\nand read or list organizations they have signed up.\n\nTo find out an API operation supports Partner tokens, look in the **AUTHORIZATIONS**\nlisting for `confluent-partner-access-token`.\n\n<!-- TODO: port this back to the Confluent API Design Guide -->\n\n<SecurityDefinitions />\n\n# Errors\n\n<div class=\"status-info\">\n<p class=\"status-info-title\">Note</p>\nThis section describes the structure of error responses for many Confluent Cloud APIs, but not all.\nThe Connect v1 API group has a different set of structures for error responses. Please review the example\nrequest and response bodies in the Connect v1 API documentation <a href=\"#tag/Connectors-(v1)\">below</a>\nto see its error behaviour.\n</div>\n\nConfluent uses conventional [HTTP status codes](#section/HTTP-Guidelines/Status-Codes) to\nindicate the success or failure of an API request.\n\nFailures follow a standard model to tell you about what went wrong. They may include\none or more error objects with the following fields:\n\n| Field | Type | Description\n|------------|---------|--------------------------------------\n| id* | UUID | A unique identifier for this particular occurrence of the problem.\n| status | String | The HTTP status code applicable to this problem.\n| code | String | An application-specific error code.\n| title | String | A short, human-readable summary of the problem that **should not** change from occurrence to occurrence of the problem, except for purposes of localization.\n| detail* | String | A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.\n| source | Object | An object that references the source of the error, and optionally includes any of the following members:\n| pointer | String | A <a href=\"https://tools.ietf.org/html/rfc6901\" target=\"_blank\">JSON Pointer</a> to the associated entity in the request document (e.g. `\"/spec/title\"` for a specific attribute).\n| parameter | String | A string indicating which URI query parameter caused the error.\n| meta | Object | A meta object that contains non-standard meta-information about the error.\n| resolution | String | Instructions for the end-user for correcting the error.\n\n\\* indicates a required field\n\nAll errors include an `id` and some `detail` message. The `id` is a unique identifier — use it\nwhen you're working with Confluent support to debug a problem with a specific API call. The\n`detail` describes what went wrong.\n\nSome errors that could be handled programmatically (e.g., a Kafka cluster config is invalid)\nmay include an error `code` that briefly explains the error reported.\n\nValidation issues and similar errors include a `source` which tells you exactly\nwhat in the request was responsible for the error.\n\nFor example, a failure may look like\n\n {\n \"errors\": [{\n \"status\": \"422\",\n \"code\": \"invalid_configuration\",\n \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\",\n \"title\": \"The Kafka cluster configuration is invalid\",\n \"detail\": \"The property '/cluster/storage_size' of type string did not match the following type: integer\",\n \"source\": {\n \"pointer\": \"/cluster/storage_size\"\n }\n }]\n }\n\nIf a request fails validation, it will return an HTTP `422 Unprocessable Entity`\nwith a list of fields that failed validation.\n\n# Pagination\n\n<div class=\"status-info\">\n<p class=\"status-info-title\">Note</p>\nThis section describes the pagination behavior of “list” operations for many Confluent Cloud APIs, but not all.\nThe Connect v1 API list operations do not support pagination.\n</div>\n\nAll API resources have support for bulk reads via \"list\" API operations. For example,\nyou can \"list Kafka clusters\", \"list api keys\", and \"list environments\". These \"list\"\noperations require pagination; by requesting smaller subsets of data, API clients\nreceive a response much faster than requesting the entire, potentially large, data set.\n\nAll \"list\" operations follow the same pattern with the following parameters:\n\n* `page_size` – client-provided max number of items per page, only valid on the first request.\n* `page_token` – server-generated token used for traversing through the result set.\n\nA paginated response may include any of the following pagination links. API clients may\nfollow the respective link to page forward or backward through the result set as desired.\n\n| [Link Relation](https://www.iana.org/assignments/link-relations/link-relations.xml) | Description\n|---------|---------------------------------------\n| `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.\n| `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.\n| `first` | A link to the first page of results. This link is **optional** for collections that cannot be indexed directly to a given page.\n| `last` | A link to the last page of results. This link is **optional** for collections that cannot be indexed directly to a given page.\n\nAPI clients must treat pagination links and the `page_token` parameter in particular as an opaque string. \n\nAn example paginated list response may look like\n```\n{\n \"api_version\": \"v2\",\n \"kind\": \"KafkaClusterList\",\n \"metadata\": {\n \"next\": \"https://api.confluent.cloud/kafka-clusters?page_token=ABCDEFGHIJKLMNOP1234567890\"\n }\n \"data\": [\n {\n \"metadata\": {\n \"id\": \"lkc-abc123\",\n \"self\": \"https://api.confluent.cloud/kafka-clusters/lkc-abc123\",\n \"resource_name\": \"crn://confluent.cloud/kafka=lkc-abc123\",\n }\n \"spec\": {\n \"display_name\": \"My Kafka Cluster\",\n <snip>\n },\n \"status\": {\n \"phase\": \"RUNNING\",\n <snip>\n }\n },\n <snip>\n ]\n}\n```\n\n# Rate Limiting\n\nTo protect the stability of the API and keep it available to all users, Confluent employs\nmultiple safeguards. If you send too many requests in quick succession or perform too many\nconcurrent operations, you may be throttled or have your request rejected with an error.\n\nWhen a rate limit is breached, an HTTP `429 Too Many Requests` error is\nreturned. The following headers are sent back to provide assistance in dealing\nwith rate limits. Note that headers are not returned for a `429` error response with \n[Kafka REST API (v3)](https://docs.confluent.io/cloud/current/api.html#tag/Cluster-(v3)).\n\n| Header | Description\n|-------------------------|----------------------------------------\n| `X-RateLimit-Limit` | The maximum number of requests you're permitted to make per time period.\n| `X-RateLimit-Reset` | The relative time in seconds until the current rate limit window resets.\n| `Retry-After` | The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.\n| `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.\n\n\nConfluent 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.\n\n\nIntegrations should gracefully handle these limits by watching for `429` error responses and\nbuilding in a retry mechanism. This mechanism should follow a capped exponential backoff policy to\nprevent [retry amplification](https://landing.google.com/sre/sre-book/chapters/addressing-cascading-failures/)\n(\"retry storms\") and also introduce some randomness (\"jitter\") to avoid the\n[thundering herd effect](https://en.wikipedia.org/wiki/Thundering_herd_problem).\n\n\nIf you’re running into this error and think you need a higher rate limit, contact Confluent at\n[support@confluent.io](mailto:support@confluent.io).\n\n# Identifiers and URLs\n\nMost resources have multiple identifiers:\n* `id` is the \"natural identifier\" for an object. It is only unique within its parent resource.\n The `id` is unique across time: the ID will not be reclaimed and reused after an object is deleted.\n* `resource_name` is a Uniform Resource Identifier (URI) that is globally unique across all resources.\n This encompasses all parent resource `kind`s and `id`s necessary to uniquely identify a particular\n instance of this object `kind`. Because it uses object `id`s, the CRN will not be reclaimed and\n reused after an object is deleted. It is represented as a Confluent Resource Name (see below). \n* `self` is a Uniform Resource Locator (URL) at which an object can be addressed.\n This URL encodes the service location, API version, and other particulars necessary to\n locate the resource at a point in time.\n\nTo see how these relate to each other, consider `KafkaBroker` with `broker.id=2` in a `KafkaCluster`\nin Confluent Cloud identified as `lkc-xsi8201`. In such an example, the `KafkaBroker` has `id=2`,\nthe `resource_name` is `crn://confluent.cloud/kafka=lkc-xsi8201/broker=2` and the `self` URL may be\nsomething like `https://pkc-8wlk2n.us-west-2.aws.confluent.cloud`. Note that different identifiers\ncarry different information for different purposes, but the `resource_name` is the most complete\nand canonical identifier.\n\n## Confluent Resource Names (CRNs)\n\n*Confluent Resource Names* (CRNs) are used to uniquely identify all Confluent resources.\n\nA CRN is a valid URI having an \"authority\" of `confluent.cloud` or a self-managed\n<a href=\"https://docs.confluent.io/current/security/rbac/configure-mds/index.html\" target=\"_blank\">\nmetadata service URL</a>, followed by the minimal hierarchical set of key-value\npairs necessary to uniquely identify a resource.\n\nHere are some examples for basic resources in Confluent Cloud:\n\n| Resource | Example CRN |\n|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Organization | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a |\n| Environment | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy |\n| User | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user=u-rst9876 |\n| API Key | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user=u-zyx98/api-key=ABCDEFG9876543210 |\n| Service Account | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/service-account=sa-abc1234 |\n| Kafka Cluster | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/kafka=lkc-123abc |\n| 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 |\n| 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 |\n| Network | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/network=n-123abc |\n| Peering | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/network=n-123abc/peering=p-123abc |\n| Private Link Access | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/network=n-123abc/private-link-access=pla-123abc |\n| Transit Gateway Attachment | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/network=n-123abc/transit-gateway-attachment=tgwa-123abc |\n| Schema Registry Cluster | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/schema-registry=lsrc-789qw |\n| Schema Subject | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/schema-registry=lsrc-789qw/subject=test |\n| KEK | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/schema-registry=lsrc-789qw//kek=test_kek |\n| Connector | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector |\n| Provider Integration | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/provider-integration=cspi-123j1 |\n\n# Data Types\n\n## Primitive Types\n\n| Data Type | Representation\n|------------|---------------------\n| 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.\n| Dates | <a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC 3339</a> formatted string. UTC timezones are assumed, unless otherwise given.\n| Times | <a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC 3339</a> formatted string. UTC timezones are assumed, unless otherwise given.\n| Durations | <a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC 3339</a> formatted string.\n| Periods | <a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC 3339</a> formatted string. UTC timezones are assumed, unless otherwise given.\n| Ranges | All ranges are represented using half-open intervals with naming conventions like `[start_XXX, end_XXX)` such as `[start_time, end_time)`.\n| Enums | Most APIs use <a href=\"https://opensource.zalando.com/restful-api-guidelines/#112\" target=\"_blank\">`x-extensible-enum`</a> 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.\n\n<!-- TODO\n### Standard Objects\n\n| Money Object | https://schema.org/MonetaryAmount or https://opensource.zalando.com/restful-api-guidelines/#173\n| Price Specification | https://schema.org/PriceSpecification -> https://schema.org/UnitPriceSpecification and https://schema.org/PaymentChargeSpecification\n-->\n\n### Standard Properties\n\nConfluent uses this set of standard properties to ensure common concepts use\nthe same name and semantics across different APIs.\n\n| Name | Description\n|------------------|------------------------------------------\n| **api_version** | Many API objects have an `api_version` field indicating their API version. See the [Object Model](#section/Object-Model).\n| **kind** | Many API objects have a `kind` field indicating the kind of object it is. See the [Object Model](#section/Object-Model).\n| **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](#section/Object-Model).\n| **name** | Objects which support a client-provided unique identifier instead of a generated `id` will indicate this identifier via its `name` field.\n| **display_name** | The human-readable display name of an API object.\n| **title** | The official name of an API object, such as a company name. It should be treated as the formal version of `display_name`.\n| **description** | One or more paragraphs of text description of an entity.\n| **created_at** | The date and time the object was created, represented as a string in <a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC 3339</a> format.\n| **updated_at** | The date and time the object was last modified, represented as a string in <a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC 3339</a> format.\n| **deleted_at** | If present, the date and time after which the object was/will be deleted, represented as a string in <a href=\"https://www.ietf.org/rfc/rfc3339.txt\" target=\"_blank\">RFC 3339</a> format.\n| **page_token** | The pagination token in the List request. See [Pagination](#section/Pagination).\n| **page_size** | The pagination size in the List request. See [Pagination](#section/Pagination).\n| **total_size** | The total count of items in the list irrespective of pagination. See [Pagination](#section/Pagination).\n| **spec** | The _desired state_ specification of the resource, as observed by Confluent Cloud.\n| **status** | The _current state_ of the resource, as observed by Confluent Cloud.\n\n# Versioning\n\nConfluent APIs ensure stability for your integrations by avoiding the introduction\nof breaking changes to customers unexpectedly. Confluent will make non-breaking\nAPI changes without advance notice. Thus, API clients **must** follow the\n[Compatibility Policy](#section/Versioning/Compatibility-Policy) below to ensure your\ningtegration remains stable. All APIs follow the API Lifecycle Policy described below,\nwhich describes the guarantees API clients can rely on.\n\nBreaking changes will be [widely communicated](#communication) in advance in accordance\nwith the Confluent [Deprecation Policy](#section/Versioning/Deprecation-Policy). Confluent will provide \ntimelines and a migration path for all API changes, where available. Be sure to subscribe\nto one or more [communication channels](#communication) so you don't miss any updates!\n\nOne exception to these guidelines is for critical security issues. Confluent will take any necessary\nactions to mitigate any critical security issue as soon as possible, which may include disabling\nthe vulnerable functionality until a proper solution is available.\n\nDo not consume any Confluent API unless it is documented in the API Reference. All undocumented\nendpoints should be considered private, subject to change without notice, and not covered by any\nagreements.\n\n> Note: The version in the URL (e.g. \"v1\" or \"v2\") is not a \"major version\" in the\n[Semantic Versioning](https://semver.org/) sense. It is a \"generational version\" or \"meta version\", as seen in\nAPIs like <a href=\"https://developer.github.com/v3/versions/\" target=\"_blank\">Github API</a> or the\n<a href=\"https://stripe.com/docs/api/versioning\" target=\"_blank\">Stripe API</a>.\n\n## API Groups\n\nConfluent APIs are divided into API Groups, such as the Cluster Management for Apache Kafka (CMK) API group,\nthe Connect API group, and the Data Catalog API group. Each group has its own set of endpoints and resources,\nas well as its own API group version.\n\nBecause different API groups have different versions, there is no single version for the \"Confluent Cloud API\".\nThe latest version of the Connect API group may be `connect/v1`, while the latest version of the CMK API group\nmay be `cmk/v2`.\n\nWhen a breaking change is introduced into one API group, Confluent will increase the API version for that API group\nonly, leaving the other API groups' versions unchanged. This makes it easier for you to understand whether a given\nbreaking change impacts your usage of the APIs.\n\n## Known Issues\n\nDuring the Early Access and Preview periods, we have a few known issues.\n\n| Issue | Description | Proposed Resolution\n|----------------|-------------------------------------------------------------------------------|-----------------------------------------------------\n| Quota Exceeded | Some \"Quota Exceeded\" errors will be returned as HTTP 400 instead of HTTP 402 | Return 402 consistently for \"Quota Exceeded\" errors \n\n## API Lifecycle Policy\n\nThe following status labels are applicable to APIs, features, and SDK versions, based on\nthe current support status of each:\n\n* **Early Access** – May change at any time. Not recommended for production usage. Not officially supported by\n Confluent. Intended for user feedback only. Users must be granted explicit access to the API by Confluent.\n* **Preview** – Unlikely to change between Preview and General Availability. Not recommended for production usage.\n Officially supported by Confluent for non-production usage. Accessible to all users.\n* **Limited Availability (LA)** - Available to key select customers in a subset of regions/providers/networks and recommended for production usage. \n* **Generally Available (GA)** – Will not change at short notice. Recommended for production usage.\n Officially supported by Confluent for non-production and production usage.\n* **Deprecated** – Still supported, but no longer under active development. Existing usage will continue to function\n but migration following the upgrade guide is strongly recommended. New use cases should be built against the new\n version. Deprecated feature or version will be removed in the future at the announced date.\n* **Sunset** – Removed, and no longer supported or available.\n\nAn API is \"Generally Available\" unless explicitly marked otherwise.\n\n## Compatibility Policy\n\nConfluent Cloud APIs are governed by\n<a href=\"https://docs.confluent.io/cloud/current/clusters/upgrade-policy.html\" target=\"_blank\">\nConfluent Cloud Upgrade Policy</a>, which means that backward incompatible changes and\ndeprecations will be made approximately once per year, and 180 days notice will be provided via email to all\nregistered Confluent Cloud users.\n\n### Backward Compatibility\n\n> _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._\n\nConfluent considers the following changes to be backward compatible:\n\n* Adding new API resources.\n* Adding new optional parameters to existing API requests (e.g., query string).\n* Adding new properties to existing API resources (e.g., request body).\n* Changing the order of properties in existing API responses.\n* Changing the length or format of object IDs or other opaque strings.\n * Unless otherwise documented, you can safely assume object IDs generated by Confluent will never exceed 255\n characters, but you should be able to handle IDs of up to that length. If you're using MySQL,\n for example, you should store IDs in a `VARCHAR(255) COLLATE utf8_bin` column.\n * This includes adding or removing fixed prefixes (such as `lkc-` on Kafka cluster IDs).\n * This includes API keys, API tokens, and similar authentication mechanisms.\n * This includes all strings described as \"opaque\" in the docs, such as pagination cursors.\n* Adding new API event types.\n* Adding new properties to existing API event types.\n* Omitting properties with null values from existing API responses.\n\n### Forward Compatibility\n\n> _An API version is forward compatible if a program written against the next version of the API\n> will continue to work the same way, without modification, against this version of the API._\n\nIn other words, a forward compatible API will accept input intended for a later version of itself.\n\nConfluent does not guarantee the forward compatibility of the APIs, but Confluent does generally follow the guidelines\ngiven by the [Robustness principle](https://en.wikipedia.org/wiki/Robustness_principle).\nThis means that the API determines what to do with a request based only on the parts that it recognizes.\n\nThis is often referred to as the MUST IGNORE rule.\n\n* Request parameters that are not recognized will be ignored (e.g., query string).\n* Request properties that are not recognized will be ignored (e.g., request body).\n* Request metadata that are not recognized will be ignored (e.g., request headers).\n\nAPI clients must also follow the MUST IGNORE rule.\n\n* Response properties that are not recognized must be ignored (e.g., response body).\n* Response metadata that are not recognized must be ignored (e.g., response headers).\n\nAdditionally, there is a more subtle related rule called the MUST FORWARD rule. Any parts of\na request that an API doesn't recognize must be forwarded unchanged.\n\n* Response properties that are not recognized must be included in any input subsequent updates (e.g., request body)\n * This includes future `PUT` requests in a read/modify/write operation.\n (This isn't required for `PATCH` partial updates, which is why Confluent APIs use `PATCH`.)\n* Event processors must not strip unknown properties before forwarding messages.\n\n### Client Responsibilities\n\n* Resource and rate limits, and the default and maximum sizes of paginated data **are not**\n considered part of the API contract and may change (possibly dynamically). It is the client's\n responsibility to read the road signs and obey the speed limit.\n* If a property has a primitive type and the API documentation does not explicitly limit its\n possible values, clients **must not** assume the values are constrained to a particular set\n of possible responses.\n* If a property of an object is not explicitly declared as mandatory in the API, clients\n **must not** assume it will be present.\n* A resource **may** be modified to return a \"redirection\" response (e.g. `301`, `307`) instead of\n directly returning the resource. Clients **must** handle HTTP-level redirects, and respect HTTP\n headers (e.g. `Location`).\n\n## Deprecation Policy\n\nConfluent will announce deprecations at least 180 days in advance of a breaking change\nand will continue to maintain the deprecated APIs in their original form during this time.\n\nExceptions to this policy apply in case of critical security vulnerabilities or functional defects.\n\n### Communication\n\nWhen a deprecation is announced, the details and any relevant migration\ninformation will be available on one or more of the following channels:\n\n* Announcements on the <a href=\"https://www.confluent.io/blog/\" target=\"_blank\">Developer Blog</a>,\n <a href=\"https://confluentcommunity.slack.com\" target=\"_blank\">Community Slack</a>\n (<a href=\"https://slackpass.io/confluentcommunity\" target=\"_blank\">join!</a>),\n <a href=\"https://groups.google.com/forum/#!forum/confluent-platform\" target=\"_blank\">Google Group</a>,\n the <a href=\"https://twitter.com/ConfluentInc\" target=\"_blank\">@ConfluentInc twitter</a>\n account, and similar channels\n* Enterprise customers may receive information by email to their specified Confluent contact, if applicable.\n\n<!-- TODO:\n### Discoverability\n-->\n\n# HTTP Guidelines\n\n## Status Codes\n\nConfluent respects the meanings and behavior of HTTP status codes as defined\nin <a href=\"https://tools.ietf.org/html/rfc2616\">RFC2616</a> and elsewhere.\n\n* Codes in the `2xx` range indicate success\n* Codes in the `3xx` range indicate redirection\n* Codes in the `4xx` range indicate an error caused by the client request\n (e.g., a required parameter was omitted, an invalid cluster configuration was provided, etc.)\n* Codes in the `5xx` range indicate an error with Confluent's servers (these are rare)\n\nThe various HTTP status codes that might be returned are listed below.\n\n| Code | Title | Description\n|------|------------------------|--------------------------------\n| 200 | OK | Everything worked as expected.\n| 201 | Created | The resource was created. Follow the `Location` header.\n| 204 | No Content | Everything worked and there is no content to return.\n| 400 | Bad Request\t | The request was unacceptable, often due to malformed syntax, or a missing or malformed parameter.\n| 401 | Unauthorized | No valid credentials provided. or the credentials are unsuitable, invalid, or unauthorized.\n| 402 | Over Quota | The request was valid, but you've exceeded your plan quota or limits.\n| 404 | Not Found | The requested resource doesn't exist or you're unauthorized to know it exists.\n| 409 | Conflict | The request conflicts with another request (perhaps it already exists or was based on a stale version of data).\n| 422 | Validation Failed | The request was parsed correctly but failed some sort of validation.\n| 429 | Too Many Requests | Too many requests hit the API too quickly. Confluent recommends an exponential backoff of your requests.\n| 500, 502, 503, 504 | Server Errors | Something went wrong on Confluent's end. (These are rare.)\n\nThis list is not exhaustive; other standard HTTP error codes may be used,\nincluding `304`, `307`, `308`, `405`, `406`, `408`, `410`, and `415`.\n\nFor more details, see https://httpstatuses.com.\n\n<!--\n\n## Method Overriding\n\nSome firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those\nenvironments, Confluent API operations that require `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible.\n\nTo avoid this issue, Confluent APIs support the `X-HTTP-Method-Override` header, allowing clients to\n\"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request.\n\nFor example, to call a Confluent `PATCH` resource via a `POST` request, you can\ninclude `X-HTTP-Method-Override: PATCH` as a header.\n\n## User Agent Required\n\nConfluent API requests **should** include a valid `User-Agent` header. Requests with no `User-Agent`\nheader may be rejected. You should use the name of your integration for the `User-Agent`\nheader value and include contact information so that Confluent can contact you if there are problems.\n\n> If your integration is acting as a proxy or gateway, you **should** forward the User-Agent\n> of the originating client with your API requests.\n\nHere's a complete example:\n\n User-Agent: CoolToolName/1.2.3 (https://example.org/CoolTool/; CoolTool@example.org) UsedBaseLibrary/2.1.0\n\nThe minimum user agent string is the integration name and version: `name/version`.\nYou can string together multiple values in a space-separated list. The full syntax is:\n\n name/version [(comments)] [name/version [(comments)]] [...]\n\nFor the integration name, use a string (without whitespace) that clearly and meaningfully\nidentifies your integration.\n\n* Avoid ambiguous names: `Confluent-Integration`, `Kafka-Sink`\n* Use clear and meaningful names: `ABCTools-ToolName`, `StackStorm-Confluent-Plugin`\n\nFor the version, use a semantic version, build ID, commit hash, or other identifier\nthat is updated automatically when you release a new version.\n\nWrap comments in parentheses `()` as a semi-colon separated list. Helpful comments to include:\n\n* A public URL for your integration, such as a GitHub link or a page in your\n docs site that describes the integration.\n* Contact information so that Confluent can easily reach the integration publisher. This\n information from the user agent string will never be shared nor used by Confluent for\n any purpose other than discussing the integration with its publisher.\n\nIf you provide an invalid `User-Agent` header, you may receive a `403 Forbidden` response.\n\n-->\n\n# Metrics APIs\n\nFor Metrics APIs, see <a href=\"https://api.telemetry.confluent.cloud/docs\">Confluent Cloud Metrics API</a>.\n"
},
"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)"
]
},
{
"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)"
]
},
{
"name": "Kafka API (v3)",
"tags": [
"Cluster (v3)",
"Configs (v3)",
"ACL (v3)",
"Consumer Group (v3)",
"Partition (v3)",
"Topic (v3)",
"Records (v3)",
"Cluster Linking (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)"]
},
{
"name": "SQL API (v1)",
"tags": [
"Statements (sql/v1)",
"Statement Results (sql/v1)",
"Statement Exceptions (sql/v1)",
"Connections (sql/v1)"
]
},
{
"name": "Provider Integration Management (v1)",
"tags": ["Integrations (pim/v1)"]
},
{
"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)"
]
}
],
"paths": {
"/iam/v2/api-keys": {
"get": {
"operationId": "listIamV2ApiKeys",
"summary": "List of API Keys",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve a sorted, filtered, paginated list of all API keys.\n\nThis can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single\nresource (across owners). If no `owner` or `resource` filters are specified, returns all API Keys in the\norganization. You will only see the keys that are accessible to the account making the API request.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/api-keys?spec.owner=SOME_STRING_VALUE&spec.resource=SOME_STRING_VALUE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/api-keys?spec.owner=SOME_STRING_VALUE&spec.resource=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/api-keys?spec.owner=SOME_STRING_VALUE&spec.resource=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/api-keys?spec.owner=SOME_STRING_VALUE&spec.resource=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/api-keys?spec.owner=SOME_STRING_VALUE&spec.resource=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/api-keys?spec.owner=SOME_STRING_VALUE&spec.resource=SOME_STRING_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/api-keys?spec.owner=SOME_STRING_VALUE&spec.resource=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createIamV2ApiKey",
"summary": "Create an API Key",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/iam/v2/api-keys \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"CI kafka access key\",\"description\":\"This API key provides kafka access to cluster x\",\"owner\":{\"id\":\"u-a83k9b\"},\"resource\":{\"id\":\"lkc-c29js0\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"resource\\\":{\\\"id\\\":\\\"lkc-c29js0\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/api-keys\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/api-keys\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"resource\\\":{\\\"id\\\":\\\"lkc-c29js0\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"resource\\\":{\\\"id\\\":\\\"lkc-c29js0\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/api-keys\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/api-keys\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'CI kafka access key',\n description: 'This API key provides kafka access to cluster x',\n owner: {id: 'u-a83k9b'},\n resource: {id: 'lkc-c29js0', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/api-keys\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"resource\\\":{\\\"id\\\":\\\"lkc-c29js0\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/api-keys\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"resource\\\":{\\\"id\\\":\\\"lkc-c29js0\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/api-keys/{id}": {
"get": {
"operationId": "getIamV2ApiKey",
"summary": "Read an API Key",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/api-keys/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/api-keys/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/api-keys/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/api-keys/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/api-keys/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/api-keys/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/api-keys/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateIamV2ApiKey",
"summary": "Update an API Key",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an API key.\n\n",
"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.ApiKeyUpdate"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/api-keys/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"CI kafka access key\",\"description\":\"This API key provides kafka access to cluster x\",\"owner\":{\"id\":\"string\"},\"resource\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"string\\\"},\\\"resource\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/api-keys/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/api-keys/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"string\\\"},\\\"resource\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"string\\\"},\\\"resource\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/api-keys/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/api-keys/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'CI kafka access key',\n description: 'This API key provides kafka access to cluster x',\n owner: {id: 'string'},\n resource: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/api-keys/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"string\\\"},\\\"resource\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/api-keys/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"CI kafka access key\\\",\\\"description\\\":\\\"This API key provides kafka access to cluster x\\\",\\\"owner\\\":{\\\"id\\\":\\\"string\\\"},\\\"resource\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2ApiKey",
"summary": "Delete an API Key",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/api-keys/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/api-keys/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/api-keys/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/api-keys/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/api-keys/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/api-keys/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/api-keys/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/org/v2/environments": {
"get": {
"operationId": "listOrgV2Environments",
"summary": "List of Environments",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/org/v2/environments \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/org/v2/environments\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/org/v2/environments\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/org/v2/environments\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/org/v2/environments\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/org/v2/environments\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/org/v2/environments\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createOrgV2Environment",
"summary": "Create an Environment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/org/v2/environments \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"prod-finance01\",\"stream_governance_config\":{\"package\":\"string\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/org/v2/environments\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/org/v2/environments\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/org/v2/environments\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/org/v2/environments\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({display_name: 'prod-finance01', stream_governance_config: {package: 'string'}}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/org/v2/environments\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/org/v2/environments\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/org/v2/environments/{id}": {
"get": {
"operationId": "getOrgV2Environment",
"summary": "Read an Environment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/org/v2/environments/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/org/v2/environments/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/org/v2/environments/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/org/v2/environments/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/org/v2/environments/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/org/v2/environments/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/org/v2/environments/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateOrgV2Environment",
"summary": "Update an Environment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an environment.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/org/v2/environments/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"prod-finance01\",\"stream_governance_config\":{\"package\":\"string\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/org/v2/environments/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/org/v2/environments/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/org/v2/environments/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/org/v2/environments/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({display_name: 'prod-finance01', stream_governance_config: {package: 'string'}}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/org/v2/environments/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/org/v2/environments/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"prod-finance01\\\",\\\"stream_governance_config\\\":{\\\"package\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteOrgV2Environment",
"summary": "Delete an Environment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to delete an environment.\n\nIf successful, this request will also recursively delete all of the environment's associated resources,\nincluding all Kafka clusters, connectors, etc.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/org/v2/environments/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/org/v2/environments/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/org/v2/environments/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/org/v2/environments/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/org/v2/environments/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/org/v2/environments/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/org/v2/environments/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/org/v2/organizations": {
"get": {
"operationId": "listOrgV2Organizations",
"summary": "List of Organizations",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/org/v2/organizations \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/org/v2/organizations\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/org/v2/organizations\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/org/v2/organizations\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/org/v2/organizations\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/org/v2/organizations\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/org/v2/organizations\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/org/v2/organizations/{id}": {
"get": {
"operationId": "getOrgV2Organization",
"summary": "Read an Organization",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/org/v2/organizations/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/org/v2/organizations/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/org/v2/organizations/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/org/v2/organizations/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/org/v2/organizations/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/org/v2/organizations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/org/v2/organizations/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateOrgV2Organization",
"summary": "Update an Organization",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an organization.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/org/v2/organizations/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"Finance Org\",\"jit_enabled\":true}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"Finance Org\\\",\\\"jit_enabled\\\":true}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/org/v2/organizations/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/org/v2/organizations/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"Finance Org\\\",\\\"jit_enabled\\\":true}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"Finance Org\\\",\\\"jit_enabled\\\":true}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/org/v2/organizations/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/org/v2/organizations/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({display_name: 'Finance Org', jit_enabled: true}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/org/v2/organizations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"Finance Org\\\",\\\"jit_enabled\\\":true}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/org/v2/organizations/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"Finance Org\\\",\\\"jit_enabled\\\":true}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/users": {
"get": {
"operationId": "listIamV2Users",
"summary": "List of Users",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/iam/v2/users \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/users\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/users\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/users\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/users\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/users\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/users\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/users/{id}": {
"get": {
"operationId": "getIamV2User",
"summary": "Read a User",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/users/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/users/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/users/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/users/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/users/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/users/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/users/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateIamV2User",
"summary": "Update a User",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a user.\n\n",
"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.UserUpdate"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/users/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"email\":\"marty.mcfly@example.com\",\"full_name\":\"Marty McFly\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"email\\\":\\\"marty.mcfly@example.com\\\",\\\"full_name\\\":\\\"Marty McFly\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/users/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/users/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"email\\\":\\\"marty.mcfly@example.com\\\",\\\"full_name\\\":\\\"Marty McFly\\\"}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"email\\\":\\\"marty.mcfly@example.com\\\",\\\"full_name\\\":\\\"Marty McFly\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/users/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/users/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({email: 'marty.mcfly@example.com', full_name: 'Marty McFly'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/users/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"email\\\":\\\"marty.mcfly@example.com\\\",\\\"full_name\\\":\\\"Marty McFly\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/users/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"email\\\":\\\"marty.mcfly@example.com\\\",\\\"full_name\\\":\\\"Marty McFly\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2User",
"summary": "Delete a User",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to delete a user.\n\nIf successful, this request will also recursively delete all of the user's associated resources,\nincluding its cloud and cluster API keys.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/users/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/users/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/users/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/users/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/users/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/users/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/users/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/users/{id}/auth": {
"patch": {
"summary": "Update Auth Type of a User",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nUpdate the auth type of a user",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/iam.v2.User.ConfigureUserAuthRequest"
}
}
}
},
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/users/{id}/auth' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"auth_type\":\"AUTH_TYPE_SSO\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/users/{id}/auth\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/users/{id}/auth\"\n\n\tpayload := strings.NewReader(\"{\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/users/{id}/auth\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/users/{id}/auth\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({auth_type: 'AUTH_TYPE_SSO'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/users/{id}/auth\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/users/{id}/auth\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/service-accounts": {
"get": {
"operationId": "listIamV2ServiceAccounts",
"summary": "List of Service Accounts",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/service-accounts?display_name=tf_runner_sa,mySA' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/service-accounts?display_name=tf_runner_sa,mySA\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/service-accounts?display_name=tf_runner_sa,mySA\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/service-accounts?display_name=tf_runner_sa,mySA\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/service-accounts?display_name=tf_runner_sa,mySA\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/service-accounts?display_name=tf_runner_sa,mySA\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/service-accounts?display_name=tf_runner_sa,mySA\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createIamV2ServiceAccount",
"summary": "Create a Service Account",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/iam/v2/service-accounts?assigned_resource_owner=u-a83k9b' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"DeLorean_auto_repair\",\"description\":\"Doc'\\''s repair bot for the DeLorean\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/service-accounts?assigned_resource_owner=u-a83k9b\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/service-accounts?assigned_resource_owner=u-a83k9b\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/service-accounts?assigned_resource_owner=u-a83k9b\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/service-accounts?assigned_resource_owner=u-a83k9b\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'DeLorean_auto_repair',\n description: 'Doc\\'s repair bot for the DeLorean'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/service-accounts?assigned_resource_owner=u-a83k9b\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/service-accounts?assigned_resource_owner=u-a83k9b\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/service-accounts/{id}": {
"get": {
"operationId": "getIamV2ServiceAccount",
"summary": "Read a Service Account",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/service-accounts/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/service-accounts/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/service-accounts/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/service-accounts/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/service-accounts/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/service-accounts/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/service-accounts/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateIamV2ServiceAccount",
"summary": "Update a Service Account",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a service account.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/service-accounts/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"DeLorean_auto_repair\",\"description\":\"Doc'\\''s repair bot for the DeLorean\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/service-accounts/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/service-accounts/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/service-accounts/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/service-accounts/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'DeLorean_auto_repair',\n description: 'Doc\\'s repair bot for the DeLorean'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/service-accounts/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/service-accounts/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"DeLorean_auto_repair\\\",\\\"description\\\":\\\"Doc's repair bot for the DeLorean\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2ServiceAccount",
"summary": "Delete a Service Account",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to delete a service account.\n\nIf successful, this request will also recursively delete all of the service account's associated resources,\nincluding its cloud and cluster API keys.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/service-accounts/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/service-accounts/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/service-accounts/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/service-accounts/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/service-accounts/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/service-accounts/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/service-accounts/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/invitations": {
"get": {
"operationId": "listIamV2Invitations",
"summary": "List of Invitations",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/invitations?email=johndoe@confluent.io&status=INVITE_STATUS_SENT&user=u-j93dy8&creator=u-m2r9o7' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/invitations?email=johndoe@confluent.io&status=INVITE_STATUS_SENT&user=u-j93dy8&creator=u-m2r9o7\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/invitations?email=johndoe@confluent.io&status=INVITE_STATUS_SENT&user=u-j93dy8&creator=u-m2r9o7\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/invitations?email=johndoe@confluent.io&status=INVITE_STATUS_SENT&user=u-j93dy8&creator=u-m2r9o7\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/invitations?email=johndoe@confluent.io&status=INVITE_STATUS_SENT&user=u-j93dy8&creator=u-m2r9o7\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/invitations?email=johndoe@confluent.io&status=INVITE_STATUS_SENT&user=u-j93dy8&creator=u-m2r9o7\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/invitations?email=johndoe@confluent.io&status=INVITE_STATUS_SENT&user=u-j93dy8&creator=u-m2r9o7\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createIamV2Invitation",
"summary": "Create an Invitation",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to create an invitation.\n\nThe newly invited user will not have any permissions. Give the user permission by assigning them to one or\nmore roles by creating\n[role bindings](https://docs.confluent.io/cloud/current/api.html#tag/Role-Bindings-(iamv2))\nfor the created `user`.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/iam/v2/invitations \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"email\":\"johndoe@confluent.io\",\"auth_type\":\"AUTH_TYPE_SSO\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"email\\\":\\\"johndoe@confluent.io\\\",\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/invitations\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/invitations\"\n\n\tpayload := strings.NewReader(\"{\\\"email\\\":\\\"johndoe@confluent.io\\\",\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"email\\\":\\\"johndoe@confluent.io\\\",\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/invitations\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/invitations\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({email: 'johndoe@confluent.io', auth_type: 'AUTH_TYPE_SSO'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/invitations\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"email\\\":\\\"johndoe@confluent.io\\\",\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/invitations\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"email\\\":\\\"johndoe@confluent.io\\\",\\\"auth_type\\\":\\\"AUTH_TYPE_SSO\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/invitations/{id}": {
"get": {
"operationId": "getIamV2Invitation",
"summary": "Read an Invitation",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/invitations/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/invitations/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/invitations/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/invitations/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/invitations/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/invitations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/invitations/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2Invitation",
"summary": "Delete an Invitation",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to delete an invitation.\n\nDelete will deactivate the user if the user didn't accept the invitation yet.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/invitations/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/invitations/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/invitations/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/invitations/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/invitations/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/invitations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/invitations/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/ip-groups": {
"x-request-access-name": "IP Groups API",
"get": {
"x-request-access-name": "IP Groups API",
"operationId": "listIamV2IpGroups",
"summary": "List of IP Groups",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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,
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/iam/v2/ip-groups \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-groups\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-groups\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/ip-groups\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-groups\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-groups\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-groups\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"x-request-access-name": "IP Groups API",
"operationId": "createIamV2IpGroup",
"summary": "Create an IP Group",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/iam/v2/ip-groups \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"group_name\":\"CorpNet\",\"cidr_blocks\":[\"192.168.0.0/24\",\"192.168.7.0/24\"]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-groups\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-groups\"\n\n\tpayload := strings.NewReader(\"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/ip-groups\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-groups\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({group_name: 'CorpNet', cidr_blocks: ['192.168.0.0/24', '192.168.7.0/24']}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-groups\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-groups\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/ip-groups/{id}": {
"x-request-access-name": "IP Groups API",
"get": {
"x-request-access-name": "IP Groups API",
"operationId": "getIamV2IpGroup",
"summary": "Read an IP Group",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/ip-groups/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-groups/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-groups/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/ip-groups/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-groups/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-groups/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-groups/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"x-request-access-name": "IP Groups API",
"operationId": "updateIamV2IpGroup",
"summary": "Update an IP Group",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an IP group.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/ip-groups/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"group_name\":\"CorpNet\",\"cidr_blocks\":[\"192.168.0.0/24\",\"192.168.7.0/24\"]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-groups/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-groups/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/ip-groups/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-groups/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({group_name: 'CorpNet', cidr_blocks: ['192.168.0.0/24', '192.168.7.0/24']}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-groups/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-groups/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"group_name\\\":\\\"CorpNet\\\",\\\"cidr_blocks\\\":[\\\"192.168.0.0/24\\\",\\\"192.168.7.0/24\\\"]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"x-request-access-name": "IP Groups API",
"operationId": "deleteIamV2IpGroup",
"summary": "Delete an IP Group",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/ip-groups/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-groups/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-groups/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/ip-groups/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-groups/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-groups/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-groups/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/ip-filters": {
"x-request-access-name": "IP Filters API",
"get": {
"x-request-access-name": "IP Filters API",
"operationId": "listIamV2IpFilters",
"summary": "List of IP Filters",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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,
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/iam/v2/ip-filters \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-filters\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-filters\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/ip-filters\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-filters\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-filters\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-filters\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"x-request-access-name": "IP Filters API",
"operationId": "createIamV2IpFilter",
"summary": "Create an IP Filter",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/iam/v2/ip-filters \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"filter_name\":\"Management API Rules\",\"resource_group\":\"management\",\"resource_scope\":\"crn://confluent.cloud/organization=org-123/environment=env-abc\",\"operation_groups\":[\"MANAGEMENT\",\"SCHEMA\",\"FLINK\"],\"ip_groups\":[{\"id\":\"string\"}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-filters\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-filters\"\n\n\tpayload := strings.NewReader(\"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/ip-filters\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-filters\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n filter_name: 'Management API Rules',\n resource_group: 'management',\n resource_scope: 'crn://confluent.cloud/organization=org-123/environment=env-abc',\n operation_groups: ['MANAGEMENT', 'SCHEMA', 'FLINK'],\n ip_groups: [{id: 'string'}]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-filters\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-filters\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/ip-filters/{id}": {
"x-request-access-name": "IP Filters API",
"get": {
"x-request-access-name": "IP Filters API",
"operationId": "getIamV2IpFilter",
"summary": "Read an IP Filter",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/ip-filters/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-filters/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-filters/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/ip-filters/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-filters/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-filters/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-filters/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"x-request-access-name": "IP Filters API",
"operationId": "updateIamV2IpFilter",
"summary": "Update an IP Filter",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an IP filter.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/ip-filters/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"filter_name\":\"Management API Rules\",\"resource_group\":\"management\",\"resource_scope\":\"crn://confluent.cloud/organization=org-123/environment=env-abc\",\"operation_groups\":[\"MANAGEMENT\",\"SCHEMA\",\"FLINK\"],\"ip_groups\":[{\"id\":\"string\"}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-filters/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-filters/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/ip-filters/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-filters/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n filter_name: 'Management API Rules',\n resource_group: 'management',\n resource_scope: 'crn://confluent.cloud/organization=org-123/environment=env-abc',\n operation_groups: ['MANAGEMENT', 'SCHEMA', 'FLINK'],\n ip_groups: [{id: 'string'}]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-filters/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-filters/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"filter_name\\\":\\\"Management API Rules\\\",\\\"resource_group\\\":\\\"management\\\",\\\"resource_scope\\\":\\\"crn://confluent.cloud/organization=org-123/environment=env-abc\\\",\\\"operation_groups\\\":[\\\"MANAGEMENT\\\",\\\"SCHEMA\\\",\\\"FLINK\\\"],\\\"ip_groups\\\":[{\\\"id\\\":\\\"string\\\"}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"x-request-access-name": "IP Filters API",
"operationId": "deleteIamV2IpFilter",
"summary": "Delete an IP Filter",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/ip-filters/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-filters/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-filters/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/ip-filters/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-filters/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-filters/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-filters/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/ip-filter-summary": {
"x-request-access-name": "IP Filter Summary API",
"get": {
"x-request-access-name": "IP Filter Summary API",
"operationId": "getIamV2IpFilterSummary",
"summary": "Read an IP Filter Summary",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/iam/v2/ip-filter-summary \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/ip-filter-summary\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/ip-filter-summary\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/ip-filter-summary\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/ip-filter-summary\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/ip-filter-summary\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/ip-filter-summary\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/role-bindings": {
"get": {
"operationId": "listIamV2RoleBindings",
"summary": "List of Role Bindings",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/role-bindings?principal=User:u-111aaa&role_name=CloudClusterAdmin&crn_pattern=crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/role-bindings?principal=User:u-111aaa&role_name=CloudClusterAdmin&crn_pattern=crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/role-bindings?principal=User:u-111aaa&role_name=CloudClusterAdmin&crn_pattern=crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/role-bindings?principal=User:u-111aaa&role_name=CloudClusterAdmin&crn_pattern=crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/role-bindings?principal=User:u-111aaa&role_name=CloudClusterAdmin&crn_pattern=crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/role-bindings?principal=User:u-111aaa&role_name=CloudClusterAdmin&crn_pattern=crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/role-bindings?principal=User:u-111aaa&role_name=CloudClusterAdmin&crn_pattern=crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createIamV2RoleBinding",
"summary": "Create a Role Binding",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/iam/v2/role-bindings \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"principal\":\"User:u-111aaa\",\"role_name\":\"CloudClusterAdmin\",\"crn_pattern\":\"crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"principal\\\":\\\"User:u-111aaa\\\",\\\"role_name\\\":\\\"CloudClusterAdmin\\\",\\\"crn_pattern\\\":\\\"crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/role-bindings\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/role-bindings\"\n\n\tpayload := strings.NewReader(\"{\\\"principal\\\":\\\"User:u-111aaa\\\",\\\"role_name\\\":\\\"CloudClusterAdmin\\\",\\\"crn_pattern\\\":\\\"crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"principal\\\":\\\"User:u-111aaa\\\",\\\"role_name\\\":\\\"CloudClusterAdmin\\\",\\\"crn_pattern\\\":\\\"crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/role-bindings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/role-bindings\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n principal: 'User:u-111aaa',\n role_name: 'CloudClusterAdmin',\n crn_pattern: 'crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/role-bindings\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"principal\\\":\\\"User:u-111aaa\\\",\\\"role_name\\\":\\\"CloudClusterAdmin\\\",\\\"crn_pattern\\\":\\\"crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/role-bindings\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"principal\\\":\\\"User:u-111aaa\\\",\\\"role_name\\\":\\\"CloudClusterAdmin\\\",\\\"crn_pattern\\\":\\\"crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/role-bindings/{id}": {
"get": {
"operationId": "getIamV2RoleBinding",
"summary": "Read a Role Binding",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/role-bindings/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/role-bindings/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/role-bindings/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/role-bindings/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/role-bindings/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/role-bindings/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/role-bindings/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2RoleBinding",
"summary": "Delete a Role Binding",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/role-bindings/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/role-bindings/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/role-bindings/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/role-bindings/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/role-bindings/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/role-bindings/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/role-bindings/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/notifications/v1/subscriptions": {
"get": {
"operationId": "listNotificationsV1Subscriptions",
"summary": "List of Subscriptions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/notifications/v1/subscriptions \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/subscriptions\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/subscriptions\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/notifications/v1/subscriptions\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/subscriptions\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/subscriptions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/subscriptions\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNotificationsV1Subscription",
"summary": "Create a Subscription",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/notifications/v1/subscriptions \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"current_state\":\"ENABLED\",\"notification_type\":{\"id\":\"string\"},\"integrations\":[{\"id\":\"string\"}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/subscriptions\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/subscriptions\"\n\n\tpayload := strings.NewReader(\"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/notifications/v1/subscriptions\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/subscriptions\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n current_state: 'ENABLED',\n notification_type: {id: 'string'},\n integrations: [{id: 'string'}]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/subscriptions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/subscriptions\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/notifications/v1/subscriptions/{id}": {
"get": {
"operationId": "getNotificationsV1Subscription",
"summary": "Read a Subscription",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/notifications/v1/subscriptions/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/subscriptions/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/notifications/v1/subscriptions/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/subscriptions/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNotificationsV1Subscription",
"summary": "Update a Subscription",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a subscription.\n\n",
"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.SubscriptionUpdate"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/notifications/v1/subscriptions/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"current_state\":\"ENABLED\",\"notification_type\":{\"id\":\"string\"},\"integrations\":[{\"id\":\"string\"}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/subscriptions/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/notifications/v1/subscriptions/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/subscriptions/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n current_state: 'ENABLED',\n notification_type: {id: 'string'},\n integrations: [{id: 'string'}]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"current_state\\\":\\\"ENABLED\\\",\\\"notification_type\\\":{\\\"id\\\":\\\"string\\\"},\\\"integrations\\\":[{\\\"id\\\":\\\"string\\\"}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNotificationsV1Subscription",
"summary": "Delete a Subscription",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/notifications/v1/subscriptions/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/subscriptions/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/notifications/v1/subscriptions/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/subscriptions/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/subscriptions/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/notifications/v1/integrations": {
"get": {
"operationId": "listNotificationsV1Integrations",
"summary": "List of Integrations",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/notifications/v1/integrations \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/integrations\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/integrations\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/notifications/v1/integrations\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/integrations\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/integrations\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/integrations\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNotificationsV1Integration",
"summary": "Create an Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/notifications/v1/integrations \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"Slack integration\",\"description\":\"A Slack channel integration\",\"target\":{\"kind\":\"Slack\",\"webhook_url\":\"https://hooks.slack.com/services/{id}/{id}/{id}\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/integrations\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/integrations\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/notifications/v1/integrations\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/integrations\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'Slack integration',\n description: 'A Slack channel integration',\n target: {kind: 'Slack', webhook_url: 'https://hooks.slack.com/services/{id}/{id}/{id}'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/integrations\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/integrations\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/notifications/v1/integrations/{id}": {
"get": {
"operationId": "getNotificationsV1Integration",
"summary": "Read an Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/notifications/v1/integrations/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/integrations/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/integrations/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/notifications/v1/integrations/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/integrations/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/integrations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/integrations/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNotificationsV1Integration",
"summary": "Update an Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an integration.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/notifications/v1/integrations/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"Slack integration\",\"description\":\"A Slack channel integration\",\"target\":{\"kind\":\"Slack\",\"webhook_url\":\"https://hooks.slack.com/services/{id}/{id}/{id}\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/integrations/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/integrations/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/notifications/v1/integrations/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/integrations/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'Slack integration',\n description: 'A Slack channel integration',\n target: {kind: 'Slack', webhook_url: 'https://hooks.slack.com/services/{id}/{id}/{id}'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/integrations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/integrations/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNotificationsV1Integration",
"summary": "Delete an Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/notifications/v1/integrations/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/integrations/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/integrations/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/notifications/v1/integrations/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/integrations/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/integrations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/integrations/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/notifications/v1/integrations:test": {
"post": {
"summary": "Test a Webhook, Slack or Microsoft Teams integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nSends a test notification to validate the integration. This is supported only for Webhook, Slack\nand MsTeams targets\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/notifications.v1.Integration"
},
{
"type": "object",
"required": ["display_name", "target"]
}
]
}
}
}
},
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/notifications/v1/integrations:test \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"Slack integration\",\"description\":\"A Slack channel integration\",\"target\":{\"kind\":\"Slack\",\"webhook_url\":\"https://hooks.slack.com/services/{id}/{id}/{id}\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/integrations:test\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/integrations:test\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/notifications/v1/integrations:test\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/integrations:test\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'Slack integration',\n description: 'A Slack channel integration',\n target: {kind: 'Slack', webhook_url: 'https://hooks.slack.com/services/{id}/{id}/{id}'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/integrations:test\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/integrations:test\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"Slack integration\\\",\\\"description\\\":\\\"A Slack channel integration\\\",\\\"target\\\":{\\\"kind\\\":\\\"Slack\\\",\\\"webhook_url\\\":\\\"https://hooks.slack.com/services/{id}/{id}/{id}\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/notifications/v1/notification-types": {
"get": {
"operationId": "listNotificationsV1NotificationTypes",
"summary": "List of Notification Types",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve a sorted, filtered, paginated list of all notification types.",
"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": ["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.NotificationTypeList"
}
]
}
}
},
"headers": {
"X-Request-Id": {
"schema": {
"type": "string"
},
"description": "The unique identifier for the API request."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "The maximum number of requests you're permitted to make per time period."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "The number of requests remaining in the current rate limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "The relative time in seconds until the current rate-limit window resets. \n \n**Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use 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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/notifications/v1/notification-types \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/notification-types\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/notification-types\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/notifications/v1/notification-types\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/notification-types\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/notification-types\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/notification-types\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/notifications/v1/notification-types/{id}": {
"get": {
"operationId": "getNotificationsV1NotificationType",
"summary": "Read a Notification Type",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/notifications/v1/notification-types/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/notifications/v1/notification-types/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/notifications/v1/notification-types/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/notifications/v1/notification-types/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/notifications/v1/notification-types/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/notifications/v1/notification-types/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/notifications/v1/notification-types/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cmk/v2/clusters": {
"get": {
"operationId": "listCmkV2Clusters",
"summary": "List of Clusters",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cmk/v2/clusters?environment=env-00000&spec.network=n-00000,n-00001' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cmk/v2/clusters?environment=env-00000&spec.network=n-00000,n-00001\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cmk/v2/clusters?environment=env-00000&spec.network=n-00000,n-00001\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cmk/v2/clusters?environment=env-00000&spec.network=n-00000,n-00001\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cmk/v2/clusters?environment=env-00000&spec.network=n-00000,n-00001\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cmk/v2/clusters?environment=env-00000&spec.network=n-00000,n-00001\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cmk/v2/clusters?environment=env-00000&spec.network=n-00000,n-00001\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createCmkV2Cluster",
"summary": "Create a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/cmk/v2/clusters \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"ProdKafkaCluster\",\"availability\":\"SINGLE_ZONE\",\"cloud\":\"GCP\",\"region\":\"us-east4\",\"config\":{\"kind\":\"Basic\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"network\":{\"id\":\"n-00000\",\"environment\":\"string\"},\"byok\":{\"id\":\"cck-00000\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"cck-00000\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cmk/v2/clusters\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cmk/v2/clusters\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"cck-00000\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"cck-00000\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/cmk/v2/clusters\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cmk/v2/clusters\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'ProdKafkaCluster',\n availability: 'SINGLE_ZONE',\n cloud: 'GCP',\n region: 'us-east4',\n config: {kind: 'Basic'},\n environment: {id: 'env-00000', environment: 'string'},\n network: {id: 'n-00000', environment: 'string'},\n byok: {id: 'cck-00000'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cmk/v2/clusters\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"cck-00000\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cmk/v2/clusters\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"cck-00000\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cmk/v2/clusters/{id}": {
"get": {
"operationId": "getCmkV2Cluster",
"summary": "Read a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cmk/v2/clusters/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cmk/v2/clusters/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cmk/v2/clusters/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cmk/v2/clusters/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cmk/v2/clusters/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cmk/v2/clusters/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cmk/v2/clusters/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateCmkV2Cluster",
"summary": "Update a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a cluster.\n\n",
"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.ClusterUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/cmk/v2/clusters/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"ProdKafkaCluster\",\"availability\":\"SINGLE_ZONE\",\"cloud\":\"GCP\",\"region\":\"us-east4\",\"config\":{\"kind\":\"Basic\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"network\":{\"id\":\"string\",\"environment\":\"string\"},\"byok\":{\"id\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cmk/v2/clusters/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cmk/v2/clusters/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/cmk/v2/clusters/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cmk/v2/clusters/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'ProdKafkaCluster',\n availability: 'SINGLE_ZONE',\n cloud: 'GCP',\n region: 'us-east4',\n config: {kind: 'Basic'},\n environment: {id: 'env-00000', environment: 'string'},\n network: {id: 'string', environment: 'string'},\n byok: {id: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cmk/v2/clusters/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cmk/v2/clusters/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ProdKafkaCluster\\\",\\\"availability\\\":\\\"SINGLE_ZONE\\\",\\\"cloud\\\":\\\"GCP\\\",\\\"region\\\":\\\"us-east4\\\",\\\"config\\\":{\\\"kind\\\":\\\"Basic\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"byok\\\":{\\\"id\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteCmkV2Cluster",
"summary": "Delete a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/cmk/v2/clusters/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cmk/v2/clusters/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cmk/v2/clusters/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/cmk/v2/clusters/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cmk/v2/clusters/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cmk/v2/clusters/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cmk/v2/clusters/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/ksqldbcm/v2/clusters": {
"get": {
"operationId": "listKsqldbcmV2Clusters",
"summary": "List of Clusters",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/ksqldbcm/v2/clusters?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ksqldbcm/v2/clusters?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ksqldbcm/v2/clusters?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/ksqldbcm/v2/clusters?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ksqldbcm/v2/clusters?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ksqldbcm/v2/clusters?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ksqldbcm/v2/clusters?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createKsqldbcmV2Cluster",
"summary": "Create a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/ksqldbcm/v2/clusters \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"ksqlDB_cluster_0\",\"use_detailed_processing_log\":true,\"csu\":4,\"kafka_cluster\":{\"id\":\"lkc-00000\",\"environment\":\"string\"},\"credential_identity\":{\"id\":\"u-a83k9b\"},\"environment\":{\"id\":\"env-00000\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ksqlDB_cluster_0\\\",\\\"use_detailed_processing_log\\\":true,\\\"csu\\\":4,\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"credential_identity\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ksqldbcm/v2/clusters\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ksqldbcm/v2/clusters\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"ksqlDB_cluster_0\\\",\\\"use_detailed_processing_log\\\":true,\\\"csu\\\":4,\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"credential_identity\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ksqlDB_cluster_0\\\",\\\"use_detailed_processing_log\\\":true,\\\"csu\\\":4,\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"credential_identity\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/ksqldbcm/v2/clusters\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ksqldbcm/v2/clusters\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'ksqlDB_cluster_0',\n use_detailed_processing_log: true,\n csu: 4,\n kafka_cluster: {id: 'lkc-00000', environment: 'string'},\n credential_identity: {id: 'u-a83k9b'},\n environment: {id: 'env-00000'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ksqldbcm/v2/clusters\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ksqlDB_cluster_0\\\",\\\"use_detailed_processing_log\\\":true,\\\"csu\\\":4,\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"credential_identity\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ksqldbcm/v2/clusters\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"ksqlDB_cluster_0\\\",\\\"use_detailed_processing_log\\\":true,\\\"csu\\\":4,\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"credential_identity\\\":{\\\"id\\\":\\\"u-a83k9b\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/ksqldbcm/v2/clusters/{id}": {
"get": {
"operationId": "getKsqldbcmV2Cluster",
"summary": "Read a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/ksqldbcm/v2/clusters/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ksqldbcm/v2/clusters/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ksqldbcm/v2/clusters/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/ksqldbcm/v2/clusters/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ksqldbcm/v2/clusters/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ksqldbcm/v2/clusters/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ksqldbcm/v2/clusters/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteKsqldbcmV2Cluster",
"summary": "Delete a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/ksqldbcm/v2/clusters/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ksqldbcm/v2/clusters/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ksqldbcm/v2/clusters/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/ksqldbcm/v2/clusters/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ksqldbcm/v2/clusters/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ksqldbcm/v2/clusters/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ksqldbcm/v2/clusters/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors": {
"get": {
"operationId": "listConnectv1Connectors",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createConnectv1Connector",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nCreate 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.<connector-class>..."
}
}
}
}
},
"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.\n",
"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`\n"
},
"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.\n"
},
"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.\n",
"example": "FALSE",
"default": "FALSE",
"x-extensible-enum": ["TRUE", "FALSE"]
}
},
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"string\",\"config\":{\"connector.class\":\"string\",\"name\":\"string\",\"kafka.api.key\":\"string\",\"kafka.api.secret\":\"string\",\"confluent.connector.type\":\"CUSTOM\",\"confluent.custom.plugin.id\":\"ccp-lq5m06\",\"confluent.custom.connection.endpoints\":\"string\",\"confluent.custom.schema.registry.auto\":\"FALSE\",\"property1\":\"string\",\"property2\":\"string\"},\"offsets\":[{\"partition\":{},\"offset\":{}}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"string\\\",\\\"config\\\":{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"string\\\",\\\"config\\\":{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"name\\\":\\\"string\\\",\\\"config\\\":{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'string',\n config: {\n 'connector.class': 'string',\n name: 'string',\n 'kafka.api.key': 'string',\n 'kafka.api.secret': 'string',\n 'confluent.connector.type': 'CUSTOM',\n 'confluent.custom.plugin.id': 'ccp-lq5m06',\n 'confluent.custom.connection.endpoints': 'string',\n 'confluent.custom.schema.registry.auto': 'FALSE',\n property1: 'string',\n property2: 'string'\n },\n offsets: [{partition: {}, offset: {}}]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"name\\\":\\\"string\\\",\\\"config\\\":{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"name\\\":\\\"string\\\",\\\"config\\\":{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"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": {
"operationId": "listConnectv1ConnectorsWithExpansions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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.\n- info : Returns metadata of each connector such as the configuration, task\ninformation, and type of connector.\n- status : Returns additional state information of each connector including their status and tasks.",
"schema": {
"type": "string",
"enum": ["id", "info", "status"]
}
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config": {
"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": {
"operationId": "getConnectv1ConnectorConfig",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGet 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"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.\n",
"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`\n"
},
"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.\n"
},
"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.\n",
"example": "FALSE",
"default": "FALSE",
"x-extensible-enum": ["TRUE", "FALSE"]
}
},
"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.<connector-class>..."
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"connector.class\":\"string\",\"name\":\"string\",\"kafka.api.key\":\"string\",\"kafka.api.secret\":\"string\",\"confluent.connector.type\":\"CUSTOM\",\"confluent.custom.plugin.id\":\"ccp-lq5m06\",\"confluent.custom.connection.endpoints\":\"string\",\"confluent.custom.schema.registry.auto\":\"FALSE\",\"property1\":\"string\",\"property2\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\"\n\n\tpayload := strings.NewReader(\"{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n 'connector.class': 'string',\n name: 'string',\n 'kafka.api.key': 'string',\n 'kafka.api.secret': 'string',\n 'confluent.connector.type': 'CUSTOM',\n 'confluent.custom.plugin.id': 'ccp-lq5m06',\n 'confluent.custom.connection.endpoints': 'string',\n 'confluent.custom.schema.registry.auto': 'FALSE',\n property1: 'string',\n property2: 'string'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"connector.class\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"kafka.api.key\\\":\\\"string\\\",\\\"kafka.api.secret\\\":\\\"string\\\",\\\"confluent.connector.type\\\":\\\"CUSTOM\\\",\\\"confluent.custom.plugin.id\\\":\\\"ccp-lq5m06\\\",\\\"confluent.custom.connection.endpoints\\\":\\\"string\\\",\\\"confluent.custom.schema.registry.auto\\\":\\\"FALSE\\\",\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}": {
"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": {
"operationId": "readConnectv1Connector",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGet 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteConnectv1Connector",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDelete 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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause": {
"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": {
"operationId": "pauseConnectv1Connector",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nPause 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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause\")\n .put(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause\"\n\n\treq, _ := http.NewRequest(\"PUT\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume": {
"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": {
"operationId": "resumeConnectv1Connector",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nResume 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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume\")\n .put(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume\"\n\n\treq, _ := http.NewRequest(\"PUT\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart": {
"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": {
"operationId": "restartConnectv1Connector",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\nRestart 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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart\")\n .post(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart\"\n\n\treq, _ := http.NewRequest(\"POST\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status": {
"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": {
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks": {
"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": {
"operationId": "listConnectv1ConnectorTasks",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGet 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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins": {
"get": {
"operationId": "listConnectv1ConnectorPlugins",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": {
"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": {
"operationId": "validateConnectv1ConnectorPlugin",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nValidate 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\nfields, this visibility boolean value points out if the current field should be\nvisible or not."
}
}
},
"metadata": {
"type": "object",
"description": "Map of metadata details about the connector configuration, such as type of\ninput, 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."
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"property1\":\"string\",\"property2\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate\"\n\n\tpayload := strings.NewReader(\"{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({property1: 'string', property2: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets": {
"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": {
"operationId": "getConnectv1ConnectorOffsets",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGet the current offsets for the connector. The offsets provide information on the point in the source system, \nfrom 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request": {
"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": {
"operationId": "alterConnectv1ConnectorOffsetsRequest",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRequest to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector.\nNote, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered.\nYou 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"
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"type\":\"PATCH\",\"offsets\":[{\"partition\":{},\"offset\":{}}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"type\\\":\\\"PATCH\\\",\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request\"\n\n\tpayload := strings.NewReader(\"{\\\"type\\\":\\\"PATCH\\\",\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"type\\\":\\\"PATCH\\\",\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({type: 'PATCH', offsets: [{partition: {}, offset: {}}]}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"type\\\":\\\"PATCH\\\",\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"type\\\":\\\"PATCH\\\",\\\"offsets\\\":[{\\\"partition\\\":{},\\\"offset\\\":{}}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status": {
"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": {
"operationId": "getConnectv1ConnectorOffsetsRequestStatus",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGet 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": 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: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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/custom-connector-plugins": {
"get": {
"operationId": "listConnectV1CustomConnectorPlugins",
"summary": "List of Custom Connector Plugins",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve a sorted, filtered, paginated list of all custom connector plugins.\n\nIf no `cloud` filter is specified, returns custom connector plugins from all clouds.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/custom-connector-plugins?cloud=AWS' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins?cloud=AWS\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/custom-connector-plugins?cloud=AWS\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/custom-connector-plugins?cloud=AWS\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/custom-connector-plugins?cloud=AWS\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/custom-connector-plugins?cloud=AWS\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins?cloud=AWS\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createConnectV1CustomConnectorPlugin",
"summary": "Create a Custom Connector Plugin",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/connect/v1/custom-connector-plugins \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"string\",\"description\":\"string\",\"documentation_link\":\"https://github.com/confluentinc/kafka-connect-datagen\",\"connector_class\":\"io.confluent.kafka.connect.datagen.DatagenConnector\",\"connector_type\":\"SOURCE\",\"cloud\":\"AWS\",\"sensitive_config_properties\":[\"passwords\",\"keys\",\"tokens\"],\"upload_source\":{\"location\":\"PRESIGNED_URL_LOCATION\",\"upload_id\":\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/custom-connector-plugins\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/connect/v1/custom-connector-plugins\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/custom-connector-plugins\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'string',\n description: 'string',\n documentation_link: 'https://github.com/confluentinc/kafka-connect-datagen',\n connector_class: 'io.confluent.kafka.connect.datagen.DatagenConnector',\n connector_type: 'SOURCE',\n cloud: 'AWS',\n sensitive_config_properties: ['passwords', 'keys', 'tokens'],\n upload_source: {\n location: 'PRESIGNED_URL_LOCATION',\n upload_id: 'e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66'\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/custom-connector-plugins\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/custom-connector-plugins/{id}": {
"get": {
"operationId": "getConnectV1CustomConnectorPlugin",
"summary": "Read a Custom Connector Plugin",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/custom-connector-plugins/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/connect/v1/custom-connector-plugins/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/custom-connector-plugins/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateConnectV1CustomConnectorPlugin",
"summary": "Update a Custom Connector Plugin",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a custom connector plugin.\n\n",
"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.CustomConnectorPluginUpdate"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"string\",\"description\":\"string\",\"documentation_link\":\"https://github.com/confluentinc/kafka-connect-datagen\",\"connector_class\":\"io.confluent.kafka.connect.datagen.DatagenConnector\",\"connector_type\":\"SOURCE\",\"cloud\":\"AWS\",\"sensitive_config_properties\":[\"passwords\",\"keys\",\"tokens\"],\"upload_source\":{\"location\":\"PRESIGNED_URL_LOCATION\",\"upload_id\":\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/custom-connector-plugins/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/connect/v1/custom-connector-plugins/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/custom-connector-plugins/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'string',\n description: 'string',\n documentation_link: 'https://github.com/confluentinc/kafka-connect-datagen',\n connector_class: 'io.confluent.kafka.connect.datagen.DatagenConnector',\n connector_type: 'SOURCE',\n cloud: 'AWS',\n sensitive_config_properties: ['passwords', 'keys', 'tokens'],\n upload_source: {\n location: 'PRESIGNED_URL_LOCATION',\n upload_id: 'e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66'\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"https://github.com/confluentinc/kafka-connect-datagen\\\",\\\"connector_class\\\":\\\"io.confluent.kafka.connect.datagen.DatagenConnector\\\",\\\"connector_type\\\":\\\"SOURCE\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"sensitive_config_properties\\\":[\\\"passwords\\\",\\\"keys\\\",\\\"tokens\\\"],\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteConnectV1CustomConnectorPlugin",
"summary": "Delete a Custom Connector Plugin",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/custom-connector-plugins/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/connect/v1/custom-connector-plugins/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/custom-connector-plugins/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/connect/v1/presigned-upload-url": {
"post": {
"summary": "Request a presigned upload URL for a new Custom Connector Plugin.",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRequest 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-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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/connect/v1/presigned-upload-url \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"content_format\":\"ZIP\",\"cloud\":\"AWS\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"content_format\\\":\\\"ZIP\\\",\\\"cloud\\\":\\\"AWS\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/connect/v1/presigned-upload-url\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/connect/v1/presigned-upload-url\"\n\n\tpayload := strings.NewReader(\"{\\\"content_format\\\":\\\"ZIP\\\",\\\"cloud\\\":\\\"AWS\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"content_format\\\":\\\"ZIP\\\",\\\"cloud\\\":\\\"AWS\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/connect/v1/presigned-upload-url\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/connect/v1/presigned-upload-url\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({content_format: 'ZIP', cloud: 'AWS'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/connect/v1/presigned-upload-url\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"content_format\\\":\\\"ZIP\\\",\\\"cloud\\\":\\\"AWS\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/connect/v1/presigned-upload-url\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"content_format\\\":\\\"ZIP\\\",\\\"cloud\\\":\\\"AWS\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nCreate 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls:batch \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"data\":[{\"resource_type\":\"UNKNOWN\",\"resource_name\":\"string\",\"pattern_type\":\"string\",\"principal\":\"string\",\"host\":\"string\",\"operation\":\"string\",\"permission\":\"string\"}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"data\\\":[{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}]}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls:batch\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls:batch\"\n\n\tpayload := strings.NewReader(\"{\\\"data\\\":[{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"data\\\":[{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}]}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/acls:batch\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/acls:batch\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n data: [\n {\n resource_type: 'UNKNOWN',\n resource_name: 'string',\n pattern_type: 'string',\n principal: 'string',\n host: 'string',\n operation: 'string',\n permission: 'string'\n }\n ]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls:batch\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"data\\\":[{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls:batch\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"data\\\":[{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"summary": "Create an ACL",
"operationId": "createKafkaAcls",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nCreate 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"resource_type\":\"UNKNOWN\",\"resource_name\":\"string\",\"pattern_type\":\"string\",\"principal\":\"string\",\"host\":\"string\",\"operation\":\"string\",\"permission\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls\"\n\n\tpayload := strings.NewReader(\"{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/acls\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/acls\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n resource_type: 'UNKNOWN',\n resource_name: 'string',\n pattern_type: 'string',\n principal: 'string',\n host: 'string',\n operation: 'string',\n permission: 'string'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"resource_type\\\":\\\"UNKNOWN\\\",\\\"resource_name\\\":\\\"string\\\",\\\"pattern_type\\\":\\\"string\\\",\\\"principal\\\":\\\"string\\\",\\\"host\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\",\\\"permission\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"summary": "Delete ACLs",
"operationId": "deleteKafkaAcls",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDelete 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=SOME_STRING_VALUE&pattern_type=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&permission=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn a list of dynamic cluster-wide broker configuration parameters for the specified Kafka\ncluster. 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/broker-configs\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/broker-configs\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nUpdate 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs:alter \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"data\":[{\"name\":\"string\",\"value\":\"string\",\"operation\":\"string\"}],\"validate_only\":true}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs:alter\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs:alter\"\n\n\tpayload := strings.NewReader(\"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/broker-configs:alter\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/broker-configs:alter\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n data: [{name: 'string', value: 'string', operation: 'string'}],\n validate_only: true\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs:alter\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs:alter\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/broker-configs/compression.type\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/broker-configs/compression.type\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"summary": "Update Dynamic Broker Config",
"operationId": "updateKafkaClusterConfig",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nUpdate 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"value\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\")\n .put(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"value\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/kafka/v3/clusters/cluster-1/broker-configs/compression.type\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/broker-configs/compression.type\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({value: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"value\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"value\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"summary": "Reset Dynamic Broker Config",
"operationId": "deleteKafkaClusterConfig",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReset the configuration parameter specified by ``name`` to its\ndefault 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/kafka/v3/clusters/cluster-1/broker-configs/compression.type\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/broker-configs/compression.type\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn the list of consumer groups that belong to the specified\nKafka 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/consumer-groups\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/consumer-groups\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn a list of consumers that belong to the specified consumer\ngroup.",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy) [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)\n\nReturn the maximum and total lag of the consumers belonging to the\nspecified 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy) [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)\n\nReturn a list of consumer lags of the consumers belonging to the\nspecified 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy) [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/0 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/0\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/0\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/0\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/0\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/0\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/0\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/topics\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"summary": "Create Topic",
"operationId": "createKafkaTopic",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nCreate a topic.\nAlso supports a dry-run mode that only validates whether the topic creation would succeed\nif the ``validate_only`` request property is explicitly specified and set to true. Note that\nwhen 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"topic_name\":\"string\",\"partitions_count\":0,\"replication_factor\":0,\"configs\":[{\"name\":\"string\",\"value\":\"string\"}],\"validate_only\":true}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"topic_name\\\":\\\"string\\\",\\\"partitions_count\\\":0,\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics\"\n\n\tpayload := strings.NewReader(\"{\\\"topic_name\\\":\\\"string\\\",\\\"partitions_count\\\":0,\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"topic_name\\\":\\\"string\\\",\\\"partitions_count\\\":0,\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/topics\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n topic_name: 'string',\n partitions_count: 0,\n replication_factor: 0,\n configs: [{name: 'string', value: 'string'}],\n validate_only: true\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"topic_name\\\":\\\"string\\\",\\\"partitions_count\\\":0,\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"topic_name\\\":\\\"string\\\",\\\"partitions_count\\\":0,\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/topics/topic-1\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"summary": "Update Partition Count",
"operationId": "updatePartitionCountKafkaTopic",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nIncrease the number of partitions for a topic. To update other topic\nconfigurations, 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"partitions_count\":0}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"partitions_count\\\":0}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\"\n\n\tpayload := strings.NewReader(\"{\\\"partitions_count\\\":0}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"partitions_count\\\":0}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/kafka/v3/clusters/cluster-1/topics/topic-1\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({partitions_count: 0}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"partitions_count\\\":0}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"partitions_count\\\":0}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"summary": "Delete Topic",
"operationId": "deleteKafkaTopic",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDelete 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/kafka/v3/clusters/cluster-1/topics/topic-1\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nUpdate or delete a set of topic configuration parameters.\nAlso supports a dry-run mode that only validates whether the operation would succeed if the\n``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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs:alter \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"data\":[{\"name\":\"string\",\"value\":\"string\",\"operation\":\"string\"}],\"validate_only\":true}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs:alter\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs:alter\"\n\n\tpayload := strings.NewReader(\"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs:alter\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs:alter\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n data: [{name: 'string', value: 'string', operation: 'string'}],\n validate_only: true\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs:alter\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs:alter\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"summary": "Update Topic Config",
"operationId": "updateKafkaTopicConfig",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nUpdate the configuration parameter with given `name`. To update the\nnumber of partitions, see\nhttps://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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"value\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\")\n .put(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"value\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({value: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"value\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"value\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"summary": "Reset Topic Config",
"operationId": "deleteKafkaTopicConfig",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReset 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/partitions\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/partitions\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturn the list of configuration parameters for all topics hosted by the specified\ncluster.",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/configs \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/configs\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/configs\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/topics/-/configs\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/-/configs\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/configs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/configs\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nProduce records to the given topic, returning delivery reports for each\nrecord produced. This API can be used in streaming mode by setting\n\"Transfer-Encoding: chunked\" header. For as long as the connection is\nkept open, the server will keep accepting records. Records are streamed\nto and from the server as Concatenated JSON. For each record sent to the\nserver, the server will asynchronously send back a delivery report, in\nthe same order, each with its own error_code. An error_code of 200\nindicates success. The HTTP status code will be HTTP 200 OK as long as\nthe connection is successfully established. To identify records that\nhave encountered an error, check the error_code of each delivery report.\n\nNote that the cluster_id is validated only when running in Confluent Cloud.\n\nThis API currently does not support Schema Registry integration. Sending\nschemas is not supported. Only BINARY, JSON, and STRING formats are\nsupported.",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/records \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"partition_id\":0,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}],\"key\":{\"type\":\"string\",\"data\":null},\"value\":{\"type\":\"string\",\"data\":null},\"timestamp\":\"2019-08-24T14:15:22Z\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"partition_id\\\":0,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"value\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"timestamp\\\":\\\"2019-08-24T14:15:22Z\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/records\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/records\"\n\n\tpayload := strings.NewReader(\"{\\\"partition_id\\\":0,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"value\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"timestamp\\\":\\\"2019-08-24T14:15:22Z\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"partition_id\\\":0,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"value\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"timestamp\\\":\\\"2019-08-24T14:15:22Z\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/records\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/records\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n partition_id: 0,\n headers: [{name: 'string', value: 'string'}],\n key: {type: 'string', data: null},\n value: {type: 'string', data: null},\n timestamp: '2019-08-24T14:15:22Z'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/records\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"partition_id\\\":0,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"value\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"timestamp\\\":\\\"2019-08-24T14:15:22Z\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/records\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"partition_id\\\":0,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"value\\\":{\\\"type\\\":\\\"string\\\",\\\"data\\\":null},\\\"timestamp\\\":\\\"2019-08-24T14:15:22Z\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\n``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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/links\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"summary": "Create a cluster link",
"operationId": "createKafkaLink",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nCluster link creation requires source cluster security configurations in\nthe 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"source_cluster_id\":\"string\",\"destination_cluster_id\":\"string\",\"remote_cluster_id\":\"string\",\"cluster_link_id\":\"string\",\"configs\":[{\"name\":\"name\",\"value\":\"value\"}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"source_cluster_id\\\":\\\"string\\\",\\\"destination_cluster_id\\\":\\\"string\\\",\\\"remote_cluster_id\\\":\\\"string\\\",\\\"cluster_link_id\\\":\\\"string\\\",\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links\"\n\n\tpayload := strings.NewReader(\"{\\\"source_cluster_id\\\":\\\"string\\\",\\\"destination_cluster_id\\\":\\\"string\\\",\\\"remote_cluster_id\\\":\\\"string\\\",\\\"cluster_link_id\\\":\\\"string\\\",\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"source_cluster_id\\\":\\\"string\\\",\\\"destination_cluster_id\\\":\\\"string\\\",\\\"remote_cluster_id\\\":\\\"string\\\",\\\"cluster_link_id\\\":\\\"string\\\",\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n source_cluster_id: 'string',\n destination_cluster_id: 'string',\n remote_cluster_id: 'string',\n cluster_link_id: 'string',\n configs: [{name: 'name', value: 'value'}]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"source_cluster_id\\\":\\\"string\\\",\\\"destination_cluster_id\\\":\\\"string\\\",\\\"remote_cluster_id\\\":\\\"string\\\",\\\"cluster_link_id\\\":\\\"string\\\",\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"source_cluster_id\\\":\\\"string\\\",\\\"destination_cluster_id\\\":\\\"string\\\",\\\"remote_cluster_id\\\":\\\"string\\\",\\\"cluster_link_id\\\":\\\"string\\\",\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\n``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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/links/link-sb1\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"summary": "Delete the cluster link",
"operationId": "deleteKafkaLink",
"description": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/kafka/v3/clusters/cluster-1/links/link-sb1\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nList 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/default-configs \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/default-configs\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/default-configs\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/topics/topic-1/default-configs\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/topics/topic-1/default-configs\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/default-configs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/default-configs\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"summary": "Alter the config under the cluster link",
"operationId": "updateKafkaLinkConfig",
"description": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"value\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\")\n .put(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"value\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({value: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"value\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"value\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"summary": "Reset the given config to default value",
"operationId": "deleteKafkaLinkConfig",
"description": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs/consumer.offset.sync.enable\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBatch 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",
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs:alter \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"data\":[{\"name\":\"string\",\"value\":\"string\",\"operation\":\"string\"}],\"validate_only\":true}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs:alter\")\n .put(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs:alter\"\n\n\tpayload := strings.NewReader(\"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs:alter\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/configs:alter\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n data: [{name: 'string', value: 'string', operation: 'string'}],\n validate_only: true\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs:alter\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/configs:alter\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"data\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\",\\\"operation\\\":\\\"string\\\"}],\\\"validate_only\\\":true}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nCreate a topic in the destination cluster mirroring a topic in\nthe 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"source_topic_name\":\"string\",\"mirror_topic_name\":\"string\",\"replication_factor\":0,\"configs\":[{\"name\":\"name\",\"value\":\"value\"}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"source_topic_name\\\":\\\"string\\\",\\\"mirror_topic_name\\\":\\\"string\\\",\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors\"\n\n\tpayload := strings.NewReader(\"{\\\"source_topic_name\\\":\\\"string\\\",\\\"mirror_topic_name\\\":\\\"string\\\",\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"source_topic_name\\\":\\\"string\\\",\\\"mirror_topic_name\\\":\\\"string\\\",\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n source_topic_name: 'string',\n mirror_topic_name: 'string',\n replication_factor: 0,\n configs: [{name: 'name', value: 'value'}]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"source_topic_name\\\":\\\"string\\\",\\\"mirror_topic_name\\\":\\\"string\\\",\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"source_topic_name\\\":\\\"string\\\",\\\"mirror_topic_name\\\":\\\"string\\\",\\\"replication_factor\\\":0,\\\"configs\\\":[{\\\"name\\\":\\\"name\\\",\\\"value\\\":\\\"value\\\"}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"get": {
"summary": "List mirror topics",
"operationId": "listKafkaMirrorTopicsUnderLink",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nList 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors?mirror_status=ACTIVE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors?mirror_status=ACTIVE\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors?mirror_status=ACTIVE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors?mirror_status=ACTIVE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors?mirror_status=ACTIVE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors?mirror_status=ACTIVE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors?mirror_status=ACTIVE\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nList 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/-/mirrors \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/-/mirrors\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/-/mirrors\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/links/-/mirrors\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/-/mirrors\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/-/mirrors\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/-/mirrors\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors/topic-1 \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors/topic-1\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors/topic-1\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors/topic-1\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors/topic-1\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors/topic-1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors/topic-1\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:promote \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"mirror_topic_names\":[\"string\"],\"mirror_topic_name_pattern\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:promote\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:promote\"\n\n\tpayload := strings.NewReader(\"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:promote\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:promote\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mirror_topic_names: ['string'], mirror_topic_name_pattern: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:promote\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:promote\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:failover \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"mirror_topic_names\":[\"string\"],\"mirror_topic_name_pattern\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:failover\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:failover\"\n\n\tpayload := strings.NewReader(\"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:failover\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:failover\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mirror_topic_names: ['string'], mirror_topic_name_pattern: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:failover\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:failover\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:pause \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"mirror_topic_names\":[\"string\"],\"mirror_topic_name_pattern\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:pause\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:pause\"\n\n\tpayload := strings.NewReader(\"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:pause\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:pause\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mirror_topic_names: ['string'], mirror_topic_name_pattern: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:pause\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:pause\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:resume \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"mirror_topic_names\":[\"string\"],\"mirror_topic_name_pattern\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:resume\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:resume\"\n\n\tpayload := strings.NewReader(\"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:resume\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:resume\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mirror_topic_names: ['string'], mirror_topic_name_pattern: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:resume\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:resume\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-start-mirror \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"mirror_topic_names\":[\"string\"],\"mirror_topic_name_pattern\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-start-mirror\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-start-mirror\"\n\n\tpayload := strings.NewReader(\"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-start-mirror\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-start-mirror\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mirror_topic_names: ['string'], mirror_topic_name_pattern: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-start-mirror\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-start-mirror\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-pause-mirror \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"mirror_topic_names\":[\"string\"],\"mirror_topic_name_pattern\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-pause-mirror\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-pause-mirror\"\n\n\tpayload := strings.NewReader(\"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-pause-mirror\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-pause-mirror\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mirror_topic_names: ['string'], mirror_topic_name_pattern: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-pause-mirror\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:reverse-and-pause-mirror\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:truncate-and-restore \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --data '{\"mirror_topic_names\":[\"string\"],\"mirror_topic_name_pattern\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:truncate-and-restore\")\n .post(body)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:truncate-and-restore\"\n\n\tpayload := strings.NewReader(\"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"pkc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\"\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:truncate-and-restore\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"pkc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:truncate-and-restore\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mirror_topic_names: ['string'], mirror_topic_name_pattern: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:truncate-and-restore\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-sb1/mirrors:truncate-and-restore\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"undefined\", \"{\\\"mirror_topic_names\\\":[\\\"string\\\"],\\\"mirror_topic_name_pattern\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/service-quota/v1/applied-quotas": {
"get": {
"operationId": "listServiceQuotaV1AppliedQuotas",
"summary": "List of Applied Quotas",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve a sorted, filtered, paginated list of all applied quotas.\n\nShows all quotas for a given scope.\n",
"parameters": [
{
"name": "scope",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/SearchFilter"
},
"example": "ORGANIZATION",
"description": "The applied scope the quota belongs to.\n"
},
{
"name": "environment",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SearchFilter"
},
"example": "env-00000",
"description": "The environment ID the quota is associated with.\n"
},
{
"name": "network",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SearchFilter"
},
"example": "n-12034",
"description": "The network ID the quota is associated with.\n"
},
{
"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.\n"
},
{
"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.\n"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/service-quota/v1/applied-quotas?scope=ORGANIZATION&environment=env-00000&network=n-12034&kafka_cluster=lkc-00000&id=iam.max_environments.per_org' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/service-quota/v1/applied-quotas?scope=ORGANIZATION&environment=env-00000&network=n-12034&kafka_cluster=lkc-00000&id=iam.max_environments.per_org\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/service-quota/v1/applied-quotas?scope=ORGANIZATION&environment=env-00000&network=n-12034&kafka_cluster=lkc-00000&id=iam.max_environments.per_org\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/service-quota/v1/applied-quotas?scope=ORGANIZATION&environment=env-00000&network=n-12034&kafka_cluster=lkc-00000&id=iam.max_environments.per_org\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/service-quota/v1/applied-quotas?scope=ORGANIZATION&environment=env-00000&network=n-12034&kafka_cluster=lkc-00000&id=iam.max_environments.per_org\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/service-quota/v1/applied-quotas?scope=ORGANIZATION&environment=env-00000&network=n-12034&kafka_cluster=lkc-00000&id=iam.max_environments.per_org\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/service-quota/v1/applied-quotas?scope=ORGANIZATION&environment=env-00000&network=n-12034&kafka_cluster=lkc-00000&id=iam.max_environments.per_org\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/service-quota/v1/applied-quotas/{id}": {
"get": {
"operationId": "getServiceQuotaV1AppliedQuota",
"summary": "Read an Applied Quota",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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.\nThis field is only required when retrieving a single quota and\nthe scope of quota is \"ENVIRONMENT\" or \"NETWORK\" or \"KAFKA_CLUSTER\".\n"
},
{
"name": "network",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SearchFilter"
},
"example": "n-12034",
"description": "The network ID the quota is associated with.\nThis field is only required when retrieving a single quota and\nthe scope of quota is \"NETWORK\".\n"
},
{
"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.\nThis field is required only when the scope of quota is \"KAFKA_CLUSTER\".\n"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/service-quota/v1/applied-quotas/{id}?environment=env-00000&network=n-12034&kafka_cluster=lkc-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/service-quota/v1/applied-quotas/{id}?environment=env-00000&network=n-12034&kafka_cluster=lkc-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/service-quota/v1/applied-quotas/{id}?environment=env-00000&network=n-12034&kafka_cluster=lkc-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/service-quota/v1/applied-quotas/{id}?environment=env-00000&network=n-12034&kafka_cluster=lkc-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/service-quota/v1/applied-quotas/{id}?environment=env-00000&network=n-12034&kafka_cluster=lkc-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/service-quota/v1/applied-quotas/{id}?environment=env-00000&network=n-12034&kafka_cluster=lkc-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/service-quota/v1/applied-quotas/{id}?environment=env-00000&network=n-12034&kafka_cluster=lkc-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/service-quota/v1/scopes": {
"get": {
"operationId": "listServiceQuotaV1Scopes",
"summary": "List of Scopes",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/service-quota/v1/scopes \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/service-quota/v1/scopes\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/service-quota/v1/scopes\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/service-quota/v1/scopes\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/service-quota/v1/scopes\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/service-quota/v1/scopes\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/service-quota/v1/scopes\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/service-quota/v1/scopes/{id}": {
"get": {
"operationId": "getServiceQuotaV1Scope",
"summary": "Read a Scope",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/service-quota/v1/scopes/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/service-quota/v1/scopes/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/service-quota/v1/scopes/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/service-quota/v1/scopes/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/service-quota/v1/scopes/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/service-quota/v1/scopes/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/service-quota/v1/scopes/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/partner/v2/entitlements": {
"x-request-access-name": "Partner v2",
"get": {
"x-request-access-name": "Partner v2",
"operationId": "listPartnerV2Entitlements",
"summary": "List of Entitlements",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nRetrieve 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 \\\n --url 'https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_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\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode 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\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nIRestResponse response = client.Execute(request);"
},
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/partner/v2/entitlements?organization.id=b3a17773-05cc-4431-9560-433fb4613da8' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/entitlements?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\")\n .get()\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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=b3a17773-05cc-4431-9560-433fb4613da8\"\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/partner/v2/entitlements?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/entitlements?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/entitlements?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/entitlements?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"x-request-access-name": "Partner v2",
"operationId": "createPartnerV2Entitlement",
"summary": "Create an Entitlement",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nMake 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 \\\n --url https://api.confluent.cloud/partner/v2/entitlements \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --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();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody 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\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/entitlements\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"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\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"POST\", \"/partner/v2/entitlements\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/entitlements\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n external_id: '1111-2222-3333-4444',\n name: 'Acme Prod Entitlement',\n plan_id: 'confluent-cloud-payg-prod',\n product_id: 'confluent-cloud-kafka-service-azure',\n usage_reporting_id: '1111-2222-3333-4444',\n resource_id: '1111-2222-3333-4444',\n organization: {related: 'string'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/entitlements\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_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\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/entitlements\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nrequest.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);\nIRestResponse response = client.Execute(request);"
},
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/partner/v2/entitlements \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --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\":{\"id\":\"string\",\"environment\":\"string\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody 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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/entitlements\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"POST\", \"/partner/v2/entitlements\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/entitlements\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n external_id: '1111-2222-3333-4444',\n name: 'Acme Prod Entitlement',\n plan_id: 'confluent-cloud-payg-prod',\n product_id: 'confluent-cloud-kafka-service-azure',\n usage_reporting_id: '1111-2222-3333-4444',\n resource_id: '1111-2222-3333-4444',\n organization: {id: 'string', environment: 'string'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/entitlements\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/entitlements\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nrequest.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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/partner/v2/entitlements/{id}": {
"x-request-access-name": "Partner v2",
"get": {
"x-request-access-name": "Partner v2",
"operationId": "getPartnerV2Entitlement",
"summary": "Read an Entitlement",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nMake 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 \\\n --url 'https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/partner/v2/entitlements/%7Bid%7D?organization.id=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/entitlements/%7Bid%7D?organization.id=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode 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\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nIRestResponse response = client.Execute(request);"
},
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=b3a17773-05cc-4431-9560-433fb4613da8' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\")\n .get()\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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=b3a17773-05cc-4431-9560-433fb4613da8\"\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/partner/v2/entitlements/{id}?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/entitlements/{id}?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=b3a17773-05cc-4431-9560-433fb4613da8\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/srcm/v2/regions": {
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"get": {
"deprecated": true,
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"operationId": "listSrcmV2Regions",
"summary": "List of Regions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/srcm/v2/regions?spec.cloud=AWS&spec.region_name=us-east-2&spec.packages=ESSENTIALS,ADVANCED' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v2/regions?spec.cloud=AWS&spec.region_name=us-east-2&spec.packages=ESSENTIALS,ADVANCED\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v2/regions?spec.cloud=AWS&spec.region_name=us-east-2&spec.packages=ESSENTIALS,ADVANCED\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/srcm/v2/regions?spec.cloud=AWS&spec.region_name=us-east-2&spec.packages=ESSENTIALS,ADVANCED\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v2/regions?spec.cloud=AWS&spec.region_name=us-east-2&spec.packages=ESSENTIALS,ADVANCED\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v2/regions?spec.cloud=AWS&spec.region_name=us-east-2&spec.packages=ESSENTIALS,ADVANCED\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v2/regions?spec.cloud=AWS&spec.region_name=us-east-2&spec.packages=ESSENTIALS,ADVANCED\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/srcm/v2/regions/{id}": {
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"get": {
"deprecated": true,
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"operationId": "getSrcmV2Region",
"summary": "Read a Region",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/srcm/v2/regions/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v2/regions/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v2/regions/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/srcm/v2/regions/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v2/regions/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v2/regions/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v2/regions/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/srcm/v2/clusters": {
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"get": {
"deprecated": true,
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"operationId": "listSrcmV2Clusters",
"summary": "List of Clusters",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/srcm/v2/clusters?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v2/clusters?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v2/clusters?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/srcm/v2/clusters?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v2/clusters?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v2/clusters?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v2/clusters?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"deprecated": true,
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"operationId": "createSrcmV2Cluster",
"summary": "Create a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/srcm/v2/clusters \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"package\":\"ESSENTIALS\",\"environment\":{\"id\":\"env-00000\"},\"region\":{\"id\":\"sgreg-00000\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"sgreg-00000\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v2/clusters\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v2/clusters\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"sgreg-00000\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"sgreg-00000\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/srcm/v2/clusters\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v2/clusters\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n package: 'ESSENTIALS',\n environment: {id: 'env-00000'},\n region: {id: 'sgreg-00000'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v2/clusters\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"sgreg-00000\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v2/clusters\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"sgreg-00000\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/srcm/v2/clusters/{id}": {
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"get": {
"deprecated": true,
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"operationId": "getSrcmV2Cluster",
"summary": "Read a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/srcm/v2/clusters/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v2/clusters/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v2/clusters/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/srcm/v2/clusters/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v2/clusters/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v2/clusters/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v2/clusters/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"deprecated": true,
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"operationId": "updateSrcmV2Cluster",
"summary": "Update a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a cluster.\n\n",
"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.ClusterUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/srcm/v2/clusters/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"package\":\"ESSENTIALS\",\"environment\":{\"id\":\"env-00000\"},\"region\":{\"id\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v2/clusters/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v2/clusters/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/srcm/v2/clusters/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v2/clusters/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {package: 'ESSENTIALS', environment: {id: 'env-00000'}, region: {id: 'string'}}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v2/clusters/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v2/clusters/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"package\\\":\\\"ESSENTIALS\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"region\\\":{\\\"id\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"deprecated": true,
"x-deprecated-at": "20240801T00:00:00Z",
"x-sunset-at": "20250228T00:00:00Z",
"operationId": "deleteSrcmV2Cluster",
"summary": "Delete a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/srcm/v2/clusters/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v2/clusters/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v2/clusters/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/srcm/v2/clusters/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v2/clusters/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v2/clusters/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v2/clusters/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/srcm/v3/clusters": {
"get": {
"operationId": "listSrcmV3Clusters",
"summary": "List of Clusters",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/srcm/v3/clusters?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v3/clusters?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v3/clusters?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/srcm/v3/clusters?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v3/clusters?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v3/clusters?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v3/clusters?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/srcm/v3/clusters/{id}": {
"get": {
"operationId": "getSrcmV3Cluster",
"summary": "Read a Cluster",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/srcm/v3/clusters/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/srcm/v3/clusters/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/srcm/v3/clusters/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/srcm/v3/clusters/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/srcm/v3/clusters/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/srcm/v3/clusters/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/srcm/v3/clusters/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/clusterconfig \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/clusterconfig\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/clusterconfig\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/clusterconfig\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/clusterconfig\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/clusterconfig\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/clusterconfig\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions/{version}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"version\":0,\"id\":0,\"schemaType\":\"string\",\"references\":[{\"name\":\"io.confluent.kafka.example.User\",\"subject\":\"User\",\"version\":1}],\"schema\":\"string\",\"metadata\":{\"tags\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"properties\":{\"property1\":\"string\",\"property2\":\"string\"},\"sensitive\":[\"string\"]},\"ruleSet\":{\"migrationRules\":[{\"name\":\"string\",\"doc\":\"string\",\"kind\":\"TRANSFORM\",\"mode\":\"UPGRADE\",\"type\":\"string\",\"tags\":[\"string\"],\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"expr\":\"string\",\"onSuccess\":\"string\",\"onFailure\":\"string\",\"disabled\":true}],\"domainRules\":[{\"name\":\"string\",\"doc\":\"string\",\"kind\":\"TRANSFORM\",\"mode\":\"UPGRADE\",\"type\":\"string\",\"tags\":[\"string\"],\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"expr\":\"string\",\"onSuccess\":\"string\",\"onFailure\":\"string\",\"disabled\":true}]}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions/{version}\")\n .post(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions/{version}\"\n\n\tpayload := strings.NewReader(\"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/compatibility/subjects/{subject}/versions/{version}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/compatibility/subjects/{subject}/versions/{version}\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n version: 0,\n id: 0,\n schemaType: 'string',\n references: [{name: 'io.confluent.kafka.example.User', subject: 'User', version: 1}],\n schema: 'string',\n metadata: {\n tags: {property1: ['string'], property2: ['string']},\n properties: {property1: 'string', property2: 'string'},\n sensitive: ['string']\n },\n ruleSet: {\n migrationRules: [\n {\n name: 'string',\n doc: 'string',\n kind: 'TRANSFORM',\n mode: 'UPGRADE',\n type: 'string',\n tags: ['string'],\n params: {property1: 'string', property2: 'string'},\n expr: 'string',\n onSuccess: 'string',\n onFailure: 'string',\n disabled: true\n }\n ],\n domainRules: [\n {\n name: 'string',\n doc: 'string',\n kind: 'TRANSFORM',\n mode: 'UPGRADE',\n type: 'string',\n tags: ['string'],\n params: {property1: 'string', property2: 'string'},\n expr: 'string',\n onSuccess: 'string',\n onFailure: 'string',\n disabled: true\n }\n ]\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions/{version}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions/{version}\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"version\":0,\"id\":0,\"schemaType\":\"string\",\"references\":[{\"name\":\"io.confluent.kafka.example.User\",\"subject\":\"User\",\"version\":1}],\"schema\":\"string\",\"metadata\":{\"tags\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"properties\":{\"property1\":\"string\",\"property2\":\"string\"},\"sensitive\":[\"string\"]},\"ruleSet\":{\"migrationRules\":[{\"name\":\"string\",\"doc\":\"string\",\"kind\":\"TRANSFORM\",\"mode\":\"UPGRADE\",\"type\":\"string\",\"tags\":[\"string\"],\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"expr\":\"string\",\"onSuccess\":\"string\",\"onFailure\":\"string\",\"disabled\":true}],\"domainRules\":[{\"name\":\"string\",\"doc\":\"string\",\"kind\":\"TRANSFORM\",\"mode\":\"UPGRADE\",\"type\":\"string\",\"tags\":[\"string\"],\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"expr\":\"string\",\"onSuccess\":\"string\",\"onFailure\":\"string\",\"disabled\":true}]}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions\")\n .post(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions\"\n\n\tpayload := strings.NewReader(\"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/compatibility/subjects/{subject}/versions\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/compatibility/subjects/{subject}/versions\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n version: 0,\n id: 0,\n schemaType: 'string',\n references: [{name: 'io.confluent.kafka.example.User', subject: 'User', version: 1}],\n schema: 'string',\n metadata: {\n tags: {property1: ['string'], property2: ['string']},\n properties: {property1: 'string', property2: 'string'},\n sensitive: ['string']\n },\n ruleSet: {\n migrationRules: [\n {\n name: 'string',\n doc: 'string',\n kind: 'TRANSFORM',\n mode: 'UPGRADE',\n type: 'string',\n tags: ['string'],\n params: {property1: 'string', property2: 'string'},\n expr: 'string',\n onSuccess: 'string',\n onFailure: 'string',\n disabled: true\n }\n ],\n domainRules: [\n {\n name: 'string',\n doc: 'string',\n kind: 'TRANSFORM',\n mode: 'UPGRADE',\n type: 'string',\n tags: ['string'],\n params: {property1: 'string', property2: 'string'},\n expr: 'string',\n onSuccess: 'string',\n onFailure: 'string',\n disabled: true\n }\n ]\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/compatibility/subjects/{subject}/versions\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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,\ndefault 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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/config/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/config/{subject}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/config/{subject}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/config/{subject}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"tags": ["Config (v1)"],
"summary": "Update subject compatibility level",
"description": "Update compatibility level, compatibility group, normalization,\ndefault metadata, and rule set for the specified subject. On success,\nechoes 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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/config/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"alias\":\"string\",\"normalize\":true,\"compatibility\":\"FULL_TRANSITIVE\",\"compatibilityGroup\":\"string\",\"defaultMetadata\":{\"properties\":{}},\"overrideMetadata\":{\"properties\":{}},\"defaultRuleSet\":{\"properties\":{}},\"overrideRuleSet\":{\"properties\":{}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\")\n .put(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/config/{subject}\"\n\n\tpayload := strings.NewReader(\"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/config/{subject}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/config/{subject}\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n alias: 'string',\n normalize: true,\n compatibility: 'FULL_TRANSITIVE',\n compatibilityGroup: 'string',\n defaultMetadata: {properties: {}},\n overrideMetadata: {properties: {}},\n defaultRuleSet: {properties: {}},\n overrideRuleSet: {properties: {}}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/config/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/config/{subject}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/config/{subject}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/config/{subject}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/config/{subject}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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,\nnormalization, 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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/config \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/config\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/config\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/config\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/config\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/config\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/config\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"tags": ["Config (v1)"],
"summary": "Update global compatibility level",
"description": "Updates the global compatibility level, compatibility group,\nschema normalization, default metadata, and rule set. On success, echoes the\noriginal 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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://psrc-00000.region.provider.confluent.cloud/config \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"alias\":\"string\",\"normalize\":true,\"compatibility\":\"FULL_TRANSITIVE\",\"compatibilityGroup\":\"string\",\"defaultMetadata\":{\"properties\":{}},\"overrideMetadata\":{\"properties\":{}},\"defaultRuleSet\":{\"properties\":{}},\"overrideRuleSet\":{\"properties\":{}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/config\")\n .put(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/config\"\n\n\tpayload := strings.NewReader(\"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/config\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/config\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n alias: 'string',\n normalize: true,\n compatibility: 'FULL_TRANSITIVE',\n compatibilityGroup: 'string',\n defaultMetadata: {properties: {}},\n overrideMetadata: {properties: {}},\n defaultRuleSet: {properties: {}},\n overrideRuleSet: {properties: {}}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/config\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/config\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"alias\\\":\\\"string\\\",\\\"normalize\\\":true,\\\"compatibility\\\":\\\"FULL_TRANSITIVE\\\",\\\"compatibilityGroup\\\":\\\"string\\\",\\\"defaultMetadata\\\":{\\\"properties\\\":{}},\\\"overrideMetadata\\\":{\\\"properties\\\":{}},\\\"defaultRuleSet\\\":{\\\"properties\\\":{}},\\\"overrideRuleSet\\\":{\\\"properties\\\":{}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url https://psrc-00000.region.provider.confluent.cloud/config \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/config\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/config\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/config\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/config\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/config\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/config\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/exporters \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/exporters\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://psrc-00000.region.provider.confluent.cloud/exporters \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"test-exporter\",\"contextType\":\"CUSTOM\",\"context\":\"User\",\"subjects\":[\"string\"],\"subjectRenameFormat\":\"string\",\"config\":{\"property1\":\"string\",\"property2\":\"string\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"test-exporter\\\",\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"test-exporter\\\",\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"name\\\":\\\"test-exporter\\\",\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/exporters\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'test-exporter',\n contextType: 'CUSTOM',\n context: 'User',\n subjects: ['string'],\n subjectRenameFormat: 'string',\n config: {property1: 'string', property2: 'string'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"name\\\":\\\"test-exporter\\\",\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"name\\\":\\\"test-exporter\\\",\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/exporters/{name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"contextType\":\"CUSTOM\",\"context\":\"User\",\"subjects\":[\"string\"],\"subjectRenameFormat\":\"string\",\"config\":{\"property1\":\"string\",\"property2\":\"string\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}\"\n\n\tpayload := strings.NewReader(\"{\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/exporters/{name}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contextType: 'CUSTOM',\n context: 'User',\n subjects: ['string'],\n subjectRenameFormat: 'string',\n config: {property1: 'string', property2: 'string'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"contextType\\\":\\\"CUSTOM\\\",\\\"context\\\":\\\"User\\\",\\\"subjects\\\":[\\\"string\\\"],\\\"subjectRenameFormat\\\":\\\"string\\\",\\\"config\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/exporters/{name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/status' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/status\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}/status\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/exporters/{name}/status\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}/status\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/status\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/status\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/exporters/{name}/config\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}/config\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"tags": ["Exporters (v1)"],
"summary": "Update schema exporter config by name",
"description": "Retrieves the config 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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"schema.registry.url\":\"<Physical SR Endpoint>\",\"basic.auth.credentials.source\":\"USER_INFO\",\"basic.auth.user.info\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"schema.registry.url\\\":\\\"<Physical SR Endpoint>\\\",\\\"basic.auth.credentials.source\\\":\\\"USER_INFO\\\",\\\"basic.auth.user.info\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config\"\n\n\tpayload := strings.NewReader(\"{\\\"schema.registry.url\\\":\\\"<Physical SR Endpoint>\\\",\\\"basic.auth.credentials.source\\\":\\\"USER_INFO\\\",\\\"basic.auth.user.info\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"schema.registry.url\\\":\\\"<Physical SR Endpoint>\\\",\\\"basic.auth.credentials.source\\\":\\\"USER_INFO\\\",\\\"basic.auth.user.info\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/exporters/{name}/config\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}/config\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n 'schema.registry.url': '<Physical SR Endpoint>',\n 'basic.auth.credentials.source': 'USER_INFO',\n 'basic.auth.user.info': 'string'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"schema.registry.url\\\":\\\"<Physical SR Endpoint>\\\",\\\"basic.auth.credentials.source\\\":\\\"USER_INFO\\\",\\\"basic.auth.user.info\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/config\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"schema.registry.url\\\":\\\"<Physical SR Endpoint>\\\",\\\"basic.auth.credentials.source\\\":\\\"USER_INFO\\\",\\\"basic.auth.user.info\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/pause' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/pause\")\n .put(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}/pause\"\n\n\treq, _ := http.NewRequest(\"PUT\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/exporters/{name}/pause\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}/pause\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/pause\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/pause\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/reset' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/reset\")\n .put(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}/reset\"\n\n\treq, _ := http.NewRequest(\"PUT\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/exporters/{name}/reset\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}/reset\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/reset\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/reset\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/resume' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/resume\")\n .put(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/exporters/{name}/resume\"\n\n\treq, _ := http.NewRequest(\"PUT\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"PUT\", \"/exporters/{name}/resume\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/exporters/{name}/resume\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/resume\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/exporters/{name}/resume\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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",
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/contexts \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/contexts\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/contexts\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/contexts\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/contexts\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/contexts\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/contexts\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/mode/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/mode/{subject}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/mode/{subject}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/mode/{subject}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/mode/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"mode\":\"READWRITE\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mode\\\":\\\"READWRITE\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\")\n .put(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/mode/{subject}\"\n\n\tpayload := strings.NewReader(\"{\\\"mode\\\":\\\"READWRITE\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mode\\\":\\\"READWRITE\\\"}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/mode/{subject}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/mode/{subject}\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mode: 'READWRITE'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mode\\\":\\\"READWRITE\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"mode\\\":\\\"READWRITE\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/mode/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/mode/{subject}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/mode/{subject}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/mode/{subject}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/mode/{subject}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/mode \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/mode\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/mode\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/mode\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/mode\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/mode\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/mode\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://psrc-00000.region.provider.confluent.cloud/mode \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"mode\":\"READWRITE\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"mode\\\":\\\"READWRITE\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/mode\")\n .put(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/mode\"\n\n\tpayload := strings.NewReader(\"{\\\"mode\\\":\\\"READWRITE\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"mode\\\":\\\"READWRITE\\\"}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/mode\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/mode\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({mode: 'READWRITE'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/mode\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"mode\\\":\\\"READWRITE\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/mode\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"mode\\\":\\\"READWRITE\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "fetchMaxId",
"in": "query",
"description": "Whether to fetch the maximum schema identifier that exists",
"schema": {
"type": "boolean",
"default": false
}
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/schemas/ids/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/schemas/ids/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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",
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/schema' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/schema\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/schema\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/schemas/ids/{id}/schema\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/schemas/ids/{id}/schema\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/schema\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/schema\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/schemas/types \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/schemas/types\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/schemas/types\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/schemas/types\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/schemas/types\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/schemas/types\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/schemas/types\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "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": "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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/schemas \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/schemas\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/schemas\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/schemas\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/schemas\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/schemas\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/schemas\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "deleted",
"in": "query",
"description": "Whether to include subjects where the schema was deleted",
"schema": {
"type": "boolean"
}
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/subjects' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/subjects\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/subjects\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/schemas/ids/{id}/subjects\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/schemas/ids/{id}/subjects\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/subjects\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/subjects\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/versions' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/versions\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/versions\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/schemas/ids/{id}/versions\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/schemas/ids/{id}/versions\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/versions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/schemas/ids/{id}/versions\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/subjects/{subject}/versions/{version}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects/{subject}/versions/{version}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/subjects/{subject}/versions/{version}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects/{subject}/versions/{version}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/referencedby' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/referencedby\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/referencedby\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/subjects/{subject}/versions/{version}/referencedby\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects/{subject}/versions/{version}/referencedby\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/referencedby\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/referencedby\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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\"}\"}"
}
}
}
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/schema' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/schema\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/schema\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/subjects/{subject}/versions/{version}/schema\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects/{subject}/versions/{version}/schema\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/schema\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}/schema\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/subjects/{subject}/versions\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects/{subject}/versions\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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.\nA 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\nWhen 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"
}
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"version\":0,\"id\":0,\"schemaType\":\"string\",\"references\":[{\"name\":\"io.confluent.kafka.example.User\",\"subject\":\"User\",\"version\":1}],\"schema\":\"string\",\"metadata\":{\"tags\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"properties\":{\"property1\":\"string\",\"property2\":\"string\"},\"sensitive\":[\"string\"]},\"ruleSet\":{\"migrationRules\":[{\"name\":\"string\",\"doc\":\"string\",\"kind\":\"TRANSFORM\",\"mode\":\"UPGRADE\",\"type\":\"string\",\"tags\":[\"string\"],\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"expr\":\"string\",\"onSuccess\":\"string\",\"onFailure\":\"string\",\"disabled\":true}],\"domainRules\":[{\"name\":\"string\",\"doc\":\"string\",\"kind\":\"TRANSFORM\",\"mode\":\"UPGRADE\",\"type\":\"string\",\"tags\":[\"string\"],\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"expr\":\"string\",\"onSuccess\":\"string\",\"onFailure\":\"string\",\"disabled\":true}]}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions\")\n .post(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions\"\n\n\tpayload := strings.NewReader(\"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/subjects/{subject}/versions\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects/{subject}/versions\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n version: 0,\n id: 0,\n schemaType: 'string',\n references: [{name: 'io.confluent.kafka.example.User', subject: 'User', version: 1}],\n schema: 'string',\n metadata: {\n tags: {property1: ['string'], property2: ['string']},\n properties: {property1: 'string', property2: 'string'},\n sensitive: ['string']\n },\n ruleSet: {\n migrationRules: [\n {\n name: 'string',\n doc: 'string',\n kind: 'TRANSFORM',\n mode: 'UPGRADE',\n type: 'string',\n tags: ['string'],\n params: {property1: 'string', property2: 'string'},\n expr: 'string',\n onSuccess: 'string',\n onFailure: 'string',\n disabled: true\n }\n ],\n domainRules: [\n {\n name: 'string',\n doc: 'string',\n kind: 'TRANSFORM',\n mode: 'UPGRADE',\n type: 'string',\n tags: ['string'],\n params: {property1: 'string', property2: 'string'},\n expr: 'string',\n onSuccess: 'string',\n onFailure: 'string',\n disabled: true\n }\n ]\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"version\":0,\"id\":0,\"schemaType\":\"string\",\"references\":[{\"name\":\"io.confluent.kafka.example.User\",\"subject\":\"User\",\"version\":1}],\"schema\":\"string\",\"metadata\":{\"tags\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"properties\":{\"property1\":\"string\",\"property2\":\"string\"},\"sensitive\":[\"string\"]},\"ruleSet\":{\"migrationRules\":[{\"name\":\"string\",\"doc\":\"string\",\"kind\":\"TRANSFORM\",\"mode\":\"UPGRADE\",\"type\":\"string\",\"tags\":[\"string\"],\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"expr\":\"string\",\"onSuccess\":\"string\",\"onFailure\":\"string\",\"disabled\":true}],\"domainRules\":[{\"name\":\"string\",\"doc\":\"string\",\"kind\":\"TRANSFORM\",\"mode\":\"UPGRADE\",\"type\":\"string\",\"tags\":[\"string\"],\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"expr\":\"string\",\"onSuccess\":\"string\",\"onFailure\":\"string\",\"disabled\":true}]}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}\")\n .post(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects/{subject}\"\n\n\tpayload := strings.NewReader(\"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/subjects/{subject}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects/{subject}\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n version: 0,\n id: 0,\n schemaType: 'string',\n references: [{name: 'io.confluent.kafka.example.User', subject: 'User', version: 1}],\n schema: 'string',\n metadata: {\n tags: {property1: ['string'], property2: ['string']},\n properties: {property1: 'string', property2: 'string'},\n sensitive: ['string']\n },\n ruleSet: {\n migrationRules: [\n {\n name: 'string',\n doc: 'string',\n kind: 'TRANSFORM',\n mode: 'UPGRADE',\n type: 'string',\n tags: ['string'],\n params: {property1: 'string', property2: 'string'},\n expr: 'string',\n onSuccess: 'string',\n onFailure: 'string',\n disabled: true\n }\n ],\n domainRules: [\n {\n name: 'string',\n doc: 'string',\n kind: 'TRANSFORM',\n mode: 'UPGRADE',\n type: 'string',\n tags: ['string'],\n params: {property1: 'string', property2: 'string'},\n expr: 'string',\n onSuccess: 'string',\n onFailure: 'string',\n disabled: true\n }\n ]\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"version\\\":0,\\\"id\\\":0,\\\"schemaType\\\":\\\"string\\\",\\\"references\\\":[{\\\"name\\\":\\\"io.confluent.kafka.example.User\\\",\\\"subject\\\":\\\"User\\\",\\\"version\\\":1}],\\\"schema\\\":\\\"string\\\",\\\"metadata\\\":{\\\"tags\\\":{\\\"property1\\\":[\\\"string\\\"],\\\"property2\\\":[\\\"string\\\"]},\\\"properties\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"sensitive\\\":[\\\"string\\\"]},\\\"ruleSet\\\":{\\\"migrationRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}],\\\"domainRules\\\":[{\\\"name\\\":\\\"string\\\",\\\"doc\\\":\\\"string\\\",\\\"kind\\\":\\\"TRANSFORM\\\",\\\"mode\\\":\\\"UPGRADE\\\",\\\"type\\\":\\\"string\\\",\\\"tags\\\":[\\\"string\\\"],\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"expr\\\":\\\"string\\\",\\\"onSuccess\\\":\\\"string\\\",\\\"onFailure\\\":\\\"string\\\",\\\"disabled\\\":true}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects/{subject}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/subjects/{subject}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects/{subject}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/subjects \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/subjects\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/subjects\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/subjects\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/subjects\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/subjects\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/subjects\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/dek-registry/v1/keks\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"tags": ["Key Encryption Keys (v1)"],
"operationId": "createKek",
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"kmsProps\":{\"key\":\"kmsProps\"},\"shared\":true,\"name\":\"name\",\"doc\":\"doc\",\"kmsKeyId\":\"kmsKeyId\",\"kmsType\":\"kmsType\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"name\\\":\\\"name\\\",\\\"doc\\\":\\\"doc\\\",\\\"kmsKeyId\\\":\\\"kmsKeyId\\\",\\\"kmsType\\\":\\\"kmsType\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks\")\n .post(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks\"\n\n\tpayload := strings.NewReader(\"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"name\\\":\\\"name\\\",\\\"doc\\\":\\\"doc\\\",\\\"kmsKeyId\\\":\\\"kmsKeyId\\\",\\\"kmsType\\\":\\\"kmsType\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"name\\\":\\\"name\\\",\\\"doc\\\":\\\"doc\\\",\\\"kmsKeyId\\\":\\\"kmsKeyId\\\",\\\"kmsType\\\":\\\"kmsType\\\"}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/dek-registry/v1/keks\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n kmsProps: {key: 'kmsProps'},\n shared: true,\n name: 'name',\n doc: 'doc',\n kmsKeyId: 'kmsKeyId',\n kmsType: 'kmsType'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"name\\\":\\\"name\\\",\\\"doc\\\":\\\"doc\\\",\\\"kmsKeyId\\\":\\\"kmsKeyId\\\",\\\"kmsType\\\":\\\"kmsType\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"name\\\":\\\"name\\\",\\\"doc\\\":\\\"doc\\\",\\\"kmsKeyId\\\":\\\"kmsKeyId\\\",\\\"kmsType\\\":\\\"kmsType\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/dek-registry/v1/keks/{name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/dek-registry/v1/keks/{name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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"
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"kmsProps\":{\"key\":\"kmsProps\"},\"shared\":true,\"doc\":\"doc\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"doc\\\":\\\"doc\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\")\n .put(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\"\n\n\tpayload := strings.NewReader(\"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"doc\\\":\\\"doc\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"doc\\\":\\\"doc\\\"}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/dek-registry/v1/keks/{name}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({kmsProps: {key: 'kmsProps'}, shared: true, doc: 'doc'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"doc\\\":\\\"doc\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"kmsProps\\\":{\\\"key\\\":\\\"kmsProps\\\"},\\\"shared\\\":true,\\\"doc\\\":\\\"doc\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/undelete' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/undelete\")\n .post(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/undelete\"\n\n\treq, _ := http.NewRequest(\"POST\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/dek-registry/v1/keks/{name}/undelete\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/undelete\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/undelete\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/undelete\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/dek-registry/v1/keks/{name}/deks\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/octet-stream' \\\n --data '{\"subject\":\"subject\",\"encryptedKeyMaterial\":\"encryptedKeyMaterial\",\"version\":0,\"algorithm\":\"AES128_GCM\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"subject\\\":\\\"subject\\\",\\\"encryptedKeyMaterial\\\":\\\"encryptedKeyMaterial\\\",\\\"version\\\":0,\\\"algorithm\\\":\\\"AES128_GCM\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks\")\n .post(body)\n .addHeader(\"content-type\", \"application/octet-stream\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks\"\n\n\tpayload := strings.NewReader(\"{\\\"subject\\\":\\\"subject\\\",\\\"encryptedKeyMaterial\\\":\\\"encryptedKeyMaterial\\\",\\\"version\\\":0,\\\"algorithm\\\":\\\"AES128_GCM\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/octet-stream\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"subject\\\":\\\"subject\\\",\\\"encryptedKeyMaterial\\\":\\\"encryptedKeyMaterial\\\",\\\"version\\\":0,\\\"algorithm\\\":\\\"AES128_GCM\\\"}\"\n\nheaders = {\n 'content-type': \"application/octet-stream\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/dek-registry/v1/keks/{name}/deks\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks\",\n \"headers\": {\n \"content-type\": \"application/octet-stream\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n subject: 'subject',\n encryptedKeyMaterial: 'encryptedKeyMaterial',\n version: 0,\n algorithm: 'AES128_GCM'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/octet-stream\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"subject\\\":\\\"subject\\\",\\\"encryptedKeyMaterial\\\":\\\"encryptedKeyMaterial\\\",\\\"version\\\":0,\\\"algorithm\\\":\\\"AES128_GCM\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/octet-stream\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/octet-stream\", \"{\\\"subject\\\":\\\"subject\\\",\\\"encryptedKeyMaterial\\\":\\\"encryptedKeyMaterial\\\",\\\"version\\\":0,\\\"algorithm\\\":\\\"AES128_GCM\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/dek-registry/v1/keks/{name}/deks/{subject}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks/{subject}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/dek-registry/v1/keks/{name}/deks/{subject}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks/{subject}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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"
}
],
"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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/dek-registry/v1/keks/{name}/deks/{subject}/versions\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks/{subject}/versions\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete\")\n .post(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete\"\n\n\treq, _ := http.NewRequest(\"POST\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": []
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/undelete' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/undelete\")\n .post(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/undelete\"\n\n\treq, _ := http.NewRequest(\"POST\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/dek-registry/v1/keks/{name}/deks/{subject}/undelete\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/dek-registry/v1/keks/{name}/deks/{subject}/undelete\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/undelete\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}/deks/{subject}/undelete\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/types/businessmetadatadefs\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/businessmetadatadefs\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"summary": "Bulk Create Business Metadata Definitions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs \\\n --header 'content-type: application/json' \\\n --data '[{\"category\":\"PRIMITIVE\",\"guid\":\"string\",\"createdBy\":\"string\",\"updatedBy\":\"string\",\"createTime\":0,\"updateTime\":0,\"version\":0,\"name\":\"string\",\"description\":\"string\",\"typeVersion\":\"string\",\"serviceType\":\"string\",\"options\":{\"property1\":\"string\",\"property2\":\"string\"},\"attributeDefs\":[{\"name\":\"string\",\"typeName\":\"string\",\"isOptional\":true,\"cardinality\":\"SINGLE\",\"valuesMinCount\":0,\"valuesMaxCount\":0,\"isUnique\":true,\"isIndexable\":true,\"includeInNotification\":true,\"defaultValue\":\"string\",\"description\":\"string\",\"searchWeight\":0,\"indexType\":\"DEFAULT\",\"constraints\":[{\"type\":\"string\",\"params\":{\"property1\":{},\"property2\":{}}}],\"options\":{\"property1\":\"string\",\"property2\":\"string\"},\"displayName\":\"string\"}]}]'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\"\n\n\tpayload := strings.NewReader(\"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"POST\", \"/catalog/v1/types/businessmetadatadefs\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/businessmetadatadefs\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {\n category: 'PRIMITIVE',\n guid: 'string',\n createdBy: 'string',\n updatedBy: 'string',\n createTime: 0,\n updateTime: 0,\n version: 0,\n name: 'string',\n description: 'string',\n typeVersion: 'string',\n serviceType: 'string',\n options: {property1: 'string', property2: 'string'},\n attributeDefs: [\n {\n name: 'string',\n typeName: 'string',\n isOptional: true,\n cardinality: 'SINGLE',\n valuesMinCount: 0,\n valuesMaxCount: 0,\n isUnique: true,\n isIndexable: true,\n includeInNotification: true,\n defaultValue: 'string',\n description: 'string',\n searchWeight: 0,\n indexType: 'DEFAULT',\n constraints: [{type: 'string', params: {property1: {}, property2: {}}}],\n options: {property1: 'string', property2: 'string'},\n displayName: 'string'\n }\n ]\n }\n]));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"summary": "Bulk Update Business Metadata Definitions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs \\\n --header 'content-type: application/json' \\\n --data '[{\"category\":\"PRIMITIVE\",\"guid\":\"string\",\"createdBy\":\"string\",\"updatedBy\":\"string\",\"createTime\":0,\"updateTime\":0,\"version\":0,\"name\":\"string\",\"description\":\"string\",\"typeVersion\":\"string\",\"serviceType\":\"string\",\"options\":{\"property1\":\"string\",\"property2\":\"string\"},\"attributeDefs\":[{\"name\":\"string\",\"typeName\":\"string\",\"isOptional\":true,\"cardinality\":\"SINGLE\",\"valuesMinCount\":0,\"valuesMaxCount\":0,\"isUnique\":true,\"isIndexable\":true,\"includeInNotification\":true,\"defaultValue\":\"string\",\"description\":\"string\",\"searchWeight\":0,\"indexType\":\"DEFAULT\",\"constraints\":[{\"type\":\"string\",\"params\":{\"property1\":{},\"property2\":{}}}],\"options\":{\"property1\":\"string\",\"property2\":\"string\"},\"displayName\":\"string\"}]}]'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\"\n\n\tpayload := strings.NewReader(\"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"PUT\", \"/catalog/v1/types/businessmetadatadefs\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/businessmetadatadefs\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {\n category: 'PRIMITIVE',\n guid: 'string',\n createdBy: 'string',\n updatedBy: 'string',\n createTime: 0,\n updateTime: 0,\n version: 0,\n name: 'string',\n description: 'string',\n typeVersion: 'string',\n serviceType: 'string',\n options: {property1: 'string', property2: 'string'},\n attributeDefs: [\n {\n name: 'string',\n typeName: 'string',\n isOptional: true,\n cardinality: 'SINGLE',\n valuesMinCount: 0,\n valuesMaxCount: 0,\n isUnique: true,\n isIndexable: true,\n includeInNotification: true,\n defaultValue: 'string',\n description: 'string',\n searchWeight: 0,\n indexType: 'DEFAULT',\n constraints: [{type: 'string', params: {property1: {}, property2: {}}}],\n options: {property1: 'string', property2: 'string'},\n displayName: 'string'\n }\n ]\n }\n]));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}]}]\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDelete 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}\")\n .delete(null)\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"DELETE\", \"/catalog/v1/types/businessmetadatadefs/{bmName}\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/businessmetadatadefs/{bmName}\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);"
}
]
},
"get": {
"summary": "Read Business Metadata Definition",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGet 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/types/businessmetadatadefs/{bmName}\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/businessmetadatadefs/{bmName}\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/businessmetadatadefs/{bmName}\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata \\\n --header 'content-type: application/json' \\\n --data '[{\"typeName\":\"string\",\"attributes\":{},\"entityType\":\"string\",\"entityName\":\"string\"}]'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata\"\n\n\tpayload := strings.NewReader(\"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"POST\", \"/catalog/v1/entity/businessmetadata\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/businessmetadata\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {typeName: 'string', attributes: {}, entityType: 'string', entityName: 'string'}\n]));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"summary": "Bulk Update Business Metadata",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata \\\n --header 'content-type: application/json' \\\n --data '[{\"typeName\":\"string\",\"attributes\":{},\"entityType\":\"string\",\"entityName\":\"string\"}]'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata\"\n\n\tpayload := strings.NewReader(\"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"PUT\", \"/catalog/v1/entity/businessmetadata\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/businessmetadata\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {typeName: 'string', attributes: {}, entityType: 'string', entityName: 'string'}\n]));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/businessmetadata\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGets the list of business metadata for a given entity represented\nby 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDelete 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}\")\n .delete(null)\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"DELETE\", \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags \\\n --header 'content-type: application/json' \\\n --data '[{\"typeName\":\"string\",\"attributes\":{},\"entityGuid\":\"string\",\"entityStatus\":\"ACTIVE\",\"propagate\":true,\"validityPeriods\":[{\"startTime\":\"string\",\"endTime\":\"string\",\"timeZone\":\"string\"}],\"removePropagationsOnEntityDelete\":true,\"entityType\":\"string\",\"entityName\":\"string\"}]'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags\"\n\n\tpayload := strings.NewReader(\"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"PUT\", \"/catalog/v1/entity/tags\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/tags\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {\n typeName: 'string',\n attributes: {},\n entityGuid: 'string',\n entityStatus: 'ACTIVE',\n propagate: true,\n validityPeriods: [{startTime: 'string', endTime: 'string', timeZone: 'string'}],\n removePropagationsOnEntityDelete: true,\n entityType: 'string',\n entityName: 'string'\n }\n]));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"summary": "Bulk Create Tags",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags \\\n --header 'content-type: application/json' \\\n --data '[{\"typeName\":\"string\",\"attributes\":{},\"entityGuid\":\"string\",\"entityStatus\":\"ACTIVE\",\"propagate\":true,\"validityPeriods\":[{\"startTime\":\"string\",\"endTime\":\"string\",\"timeZone\":\"string\"}],\"removePropagationsOnEntityDelete\":true,\"entityType\":\"string\",\"entityName\":\"string\"}]'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags\"\n\n\tpayload := strings.NewReader(\"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"POST\", \"/catalog/v1/entity/tags\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/tags\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {\n typeName: 'string',\n attributes: {},\n entityGuid: 'string',\n entityStatus: 'ACTIVE',\n propagate: true,\n validityPeriods: [{startTime: 'string', endTime: 'string', timeZone: 'string'}],\n removePropagationsOnEntityDelete: true,\n entityType: 'string',\n entityName: 'string'\n }\n]));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/tags\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true,\\\"entityType\\\":\\\"string\\\",\\\"entityName\\\":\\\"string\\\"}]\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nFetch 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGets 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nPartially 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity \\\n --header 'content-type: application/json' \\\n --data '{\"referredEntities\":{\"property1\":{\"typeName\":\"string\",\"attributes\":{},\"guid\":\"string\",\"homeId\":\"string\",\"isProxy\":true,\"isIncomplete\":true,\"provenanceType\":0,\"status\":\"ACTIVE\",\"createdBy\":\"string\",\"updatedBy\":\"string\",\"createTime\":0,\"updateTime\":0,\"version\":0,\"relationshipAttributes\":{},\"classifications\":[{\"typeName\":\"string\",\"attributes\":{\"property1\":{},\"property2\":{}},\"entityGuid\":\"string\",\"entityStatus\":\"ACTIVE\",\"propagate\":true,\"validityPeriods\":[{\"startTime\":\"string\",\"endTime\":\"string\",\"timeZone\":\"string\"}],\"removePropagationsOnEntityDelete\":true}],\"meanings\":[{\"termGuid\":\"string\",\"relationGuid\":\"string\",\"description\":\"string\",\"displayText\":\"string\",\"expression\":\"string\",\"createdBy\":\"string\",\"steward\":\"string\",\"source\":\"string\",\"confidence\":0,\"status\":\"DISCOVERED\"}],\"customAttributes\":{\"property1\":\"string\",\"property2\":\"string\"},\"businessAttributes\":{\"property1\":{},\"property2\":{}},\"labels\":[\"string\"],\"proxy\":true},\"property2\":{\"typeName\":\"string\",\"attributes\":{},\"guid\":\"string\",\"homeId\":\"string\",\"isProxy\":true,\"isIncomplete\":true,\"provenanceType\":0,\"status\":\"ACTIVE\",\"createdBy\":\"string\",\"updatedBy\":\"string\",\"createTime\":0,\"updateTime\":0,\"version\":0,\"relationshipAttributes\":{},\"classifications\":[{\"typeName\":\"string\",\"attributes\":{\"property1\":{},\"property2\":{}},\"entityGuid\":\"string\",\"entityStatus\":\"ACTIVE\",\"propagate\":true,\"validityPeriods\":[{\"startTime\":\"string\",\"endTime\":\"string\",\"timeZone\":\"string\"}],\"removePropagationsOnEntityDelete\":true}],\"meanings\":[{\"termGuid\":\"string\",\"relationGuid\":\"string\",\"description\":\"string\",\"displayText\":\"string\",\"expression\":\"string\",\"createdBy\":\"string\",\"steward\":\"string\",\"source\":\"string\",\"confidence\":0,\"status\":\"DISCOVERED\"}],\"customAttributes\":{\"property1\":\"string\",\"property2\":\"string\"},\"businessAttributes\":{\"property1\":{},\"property2\":{}},\"labels\":[\"string\"],\"proxy\":true}},\"entity\":{\"typeName\":\"string\",\"attributes\":{},\"guid\":\"string\",\"homeId\":\"string\",\"isProxy\":true,\"isIncomplete\":true,\"provenanceType\":0,\"status\":\"ACTIVE\",\"createdBy\":\"string\",\"updatedBy\":\"string\",\"createTime\":0,\"updateTime\":0,\"version\":0,\"relationshipAttributes\":{},\"classifications\":[{\"typeName\":\"string\",\"attributes\":{\"property1\":{},\"property2\":{}},\"entityGuid\":\"string\",\"entityStatus\":\"ACTIVE\",\"propagate\":true,\"validityPeriods\":[{\"startTime\":\"string\",\"endTime\":\"string\",\"timeZone\":\"string\"}],\"removePropagationsOnEntityDelete\":true}],\"meanings\":[{\"termGuid\":\"string\",\"relationGuid\":\"string\",\"description\":\"string\",\"displayText\":\"string\",\"expression\":\"string\",\"createdBy\":\"string\",\"steward\":\"string\",\"source\":\"string\",\"confidence\":0,\"status\":\"DISCOVERED\"}],\"customAttributes\":{\"property1\":\"string\",\"property2\":\"string\"},\"businessAttributes\":{\"property1\":{},\"property2\":{}},\"labels\":[\"string\"],\"proxy\":true}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"referredEntities\\\":{\\\"property1\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true},\\\"property2\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}},\\\"entity\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}}\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity\"\n\n\tpayload := strings.NewReader(\"{\\\"referredEntities\\\":{\\\"property1\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true},\\\"property2\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}},\\\"entity\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"{\\\"referredEntities\\\":{\\\"property1\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true},\\\"property2\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}},\\\"entity\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}}\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"PUT\", \"/catalog/v1/entity\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n referredEntities: {\n property1: {\n typeName: 'string',\n attributes: {},\n guid: 'string',\n homeId: 'string',\n isProxy: true,\n isIncomplete: true,\n provenanceType: 0,\n status: 'ACTIVE',\n createdBy: 'string',\n updatedBy: 'string',\n createTime: 0,\n updateTime: 0,\n version: 0,\n relationshipAttributes: {},\n classifications: [\n {\n typeName: 'string',\n attributes: {property1: {}, property2: {}},\n entityGuid: 'string',\n entityStatus: 'ACTIVE',\n propagate: true,\n validityPeriods: [{startTime: 'string', endTime: 'string', timeZone: 'string'}],\n removePropagationsOnEntityDelete: true\n }\n ],\n meanings: [\n {\n termGuid: 'string',\n relationGuid: 'string',\n description: 'string',\n displayText: 'string',\n expression: 'string',\n createdBy: 'string',\n steward: 'string',\n source: 'string',\n confidence: 0,\n status: 'DISCOVERED'\n }\n ],\n customAttributes: {property1: 'string', property2: 'string'},\n businessAttributes: {property1: {}, property2: {}},\n labels: ['string'],\n proxy: true\n },\n property2: {\n typeName: 'string',\n attributes: {},\n guid: 'string',\n homeId: 'string',\n isProxy: true,\n isIncomplete: true,\n provenanceType: 0,\n status: 'ACTIVE',\n createdBy: 'string',\n updatedBy: 'string',\n createTime: 0,\n updateTime: 0,\n version: 0,\n relationshipAttributes: {},\n classifications: [\n {\n typeName: 'string',\n attributes: {property1: {}, property2: {}},\n entityGuid: 'string',\n entityStatus: 'ACTIVE',\n propagate: true,\n validityPeriods: [{startTime: 'string', endTime: 'string', timeZone: 'string'}],\n removePropagationsOnEntityDelete: true\n }\n ],\n meanings: [\n {\n termGuid: 'string',\n relationGuid: 'string',\n description: 'string',\n displayText: 'string',\n expression: 'string',\n createdBy: 'string',\n steward: 'string',\n source: 'string',\n confidence: 0,\n status: 'DISCOVERED'\n }\n ],\n customAttributes: {property1: 'string', property2: 'string'},\n businessAttributes: {property1: {}, property2: {}},\n labels: ['string'],\n proxy: true\n }\n },\n entity: {\n typeName: 'string',\n attributes: {},\n guid: 'string',\n homeId: 'string',\n isProxy: true,\n isIncomplete: true,\n provenanceType: 0,\n status: 'ACTIVE',\n createdBy: 'string',\n updatedBy: 'string',\n createTime: 0,\n updateTime: 0,\n version: 0,\n relationshipAttributes: {},\n classifications: [\n {\n typeName: 'string',\n attributes: {property1: {}, property2: {}},\n entityGuid: 'string',\n entityStatus: 'ACTIVE',\n propagate: true,\n validityPeriods: [{startTime: 'string', endTime: 'string', timeZone: 'string'}],\n removePropagationsOnEntityDelete: true\n }\n ],\n meanings: [\n {\n termGuid: 'string',\n relationGuid: 'string',\n description: 'string',\n displayText: 'string',\n expression: 'string',\n createdBy: 'string',\n steward: 'string',\n source: 'string',\n confidence: 0,\n status: 'DISCOVERED'\n }\n ],\n customAttributes: {property1: 'string', property2: 'string'},\n businessAttributes: {property1: {}, property2: {}},\n labels: ['string'],\n proxy: true\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"referredEntities\\\":{\\\"property1\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true},\\\"property2\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}},\\\"entity\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"referredEntities\\\":{\\\"property1\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true},\\\"property2\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}},\\\"entity\\\":{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{},\\\"guid\\\":\\\"string\\\",\\\"homeId\\\":\\\"string\\\",\\\"isProxy\\\":true,\\\"isIncomplete\\\":true,\\\"provenanceType\\\":0,\\\"status\\\":\\\"ACTIVE\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"relationshipAttributes\\\":{},\\\"classifications\\\":[{\\\"typeName\\\":\\\"string\\\",\\\"attributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"entityGuid\\\":\\\"string\\\",\\\"entityStatus\\\":\\\"ACTIVE\\\",\\\"propagate\\\":true,\\\"validityPeriods\\\":[{\\\"startTime\\\":\\\"string\\\",\\\"endTime\\\":\\\"string\\\",\\\"timeZone\\\":\\\"string\\\"}],\\\"removePropagationsOnEntityDelete\\\":true}],\\\"meanings\\\":[{\\\"termGuid\\\":\\\"string\\\",\\\"relationGuid\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"displayText\\\":\\\"string\\\",\\\"expression\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"steward\\\":\\\"string\\\",\\\"source\\\":\\\"string\\\",\\\"confidence\\\":0,\\\"status\\\":\\\"DISCOVERED\\\"}],\\\"customAttributes\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"businessAttributes\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"labels\\\":[\\\"string\\\"],\\\"proxy\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDelete 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}\")\n .delete(null)\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"DELETE\", \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/attribute"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/attribute\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/attribute\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/search/attribute\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/search/attribute\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/attribute\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/attribute\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/basic"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/basic\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/basic\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/search/basic\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/search/basic\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/basic\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/search/basic\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/types/tagdefs\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/tagdefs\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"summary": "Bulk Update Tag Definitions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs \\\n --header 'content-type: application/json' \\\n --data '[{\"category\":\"PRIMITIVE\",\"guid\":\"string\",\"createdBy\":\"string\",\"updatedBy\":\"string\",\"createTime\":0,\"updateTime\":0,\"version\":0,\"name\":\"string\",\"description\":\"string\",\"typeVersion\":\"string\",\"serviceType\":\"string\",\"options\":{\"property1\":\"string\",\"property2\":\"string\"},\"attributeDefs\":[{\"name\":\"string\",\"typeName\":\"string\",\"isOptional\":true,\"cardinality\":\"SINGLE\",\"valuesMinCount\":0,\"valuesMaxCount\":0,\"isUnique\":true,\"isIndexable\":true,\"includeInNotification\":true,\"defaultValue\":\"string\",\"description\":\"string\",\"searchWeight\":0,\"indexType\":\"DEFAULT\",\"constraints\":[{\"type\":\"string\",\"params\":{\"property1\":{},\"property2\":{}}}],\"options\":{\"property1\":\"string\",\"property2\":\"string\"},\"displayName\":\"string\"}],\"superTypes\":[\"string\"],\"entityTypes\":[\"string\"],\"subTypes\":[\"string\"]}]'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\"\n\n\tpayload := strings.NewReader(\"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"PUT\", \"/catalog/v1/types/tagdefs\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/tagdefs\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {\n category: 'PRIMITIVE',\n guid: 'string',\n createdBy: 'string',\n updatedBy: 'string',\n createTime: 0,\n updateTime: 0,\n version: 0,\n name: 'string',\n description: 'string',\n typeVersion: 'string',\n serviceType: 'string',\n options: {property1: 'string', property2: 'string'},\n attributeDefs: [\n {\n name: 'string',\n typeName: 'string',\n isOptional: true,\n cardinality: 'SINGLE',\n valuesMinCount: 0,\n valuesMaxCount: 0,\n isUnique: true,\n isIndexable: true,\n includeInNotification: true,\n defaultValue: 'string',\n description: 'string',\n searchWeight: 0,\n indexType: 'DEFAULT',\n constraints: [{type: 'string', params: {property1: {}, property2: {}}}],\n options: {property1: 'string', property2: 'string'},\n displayName: 'string'\n }\n ],\n superTypes: ['string'],\n entityTypes: ['string'],\n subTypes: ['string']\n }\n]));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"summary": "Bulk Create Tag Definitions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nBulk 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs \\\n --header 'content-type: application/json' \\\n --data '[{\"category\":\"PRIMITIVE\",\"guid\":\"string\",\"createdBy\":\"string\",\"updatedBy\":\"string\",\"createTime\":0,\"updateTime\":0,\"version\":0,\"name\":\"string\",\"description\":\"string\",\"typeVersion\":\"string\",\"serviceType\":\"string\",\"options\":{\"property1\":\"string\",\"property2\":\"string\"},\"attributeDefs\":[{\"name\":\"string\",\"typeName\":\"string\",\"isOptional\":true,\"cardinality\":\"SINGLE\",\"valuesMinCount\":0,\"valuesMaxCount\":0,\"isUnique\":true,\"isIndexable\":true,\"includeInNotification\":true,\"defaultValue\":\"string\",\"description\":\"string\",\"searchWeight\":0,\"indexType\":\"DEFAULT\",\"constraints\":[{\"type\":\"string\",\"params\":{\"property1\":{},\"property2\":{}}}],\"options\":{\"property1\":\"string\",\"property2\":\"string\"},\"displayName\":\"string\"}],\"superTypes\":[\"string\"],\"entityTypes\":[\"string\"],\"subTypes\":[\"string\"]}]'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\");\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\"\n\n\tpayload := strings.NewReader(\"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\npayload = \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\"\n\nheaders = { 'content-type': \"application/json\" }\n\nconn.request(\"POST\", \"/catalog/v1/types/tagdefs\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/tagdefs\",\n \"headers\": {\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {\n category: 'PRIMITIVE',\n guid: 'string',\n createdBy: 'string',\n updatedBy: 'string',\n createTime: 0,\n updateTime: 0,\n version: 0,\n name: 'string',\n description: 'string',\n typeVersion: 'string',\n serviceType: 'string',\n options: {property1: 'string', property2: 'string'},\n attributeDefs: [\n {\n name: 'string',\n typeName: 'string',\n isOptional: true,\n cardinality: 'SINGLE',\n valuesMinCount: 0,\n valuesMaxCount: 0,\n isUnique: true,\n isIndexable: true,\n includeInNotification: true,\n defaultValue: 'string',\n description: 'string',\n searchWeight: 0,\n indexType: 'DEFAULT',\n constraints: [{type: 'string', params: {property1: {}, property2: {}}}],\n options: {property1: 'string', property2: 'string'},\n displayName: 'string'\n }\n ],\n superTypes: ['string'],\n entityTypes: ['string'],\n subTypes: ['string']\n }\n]));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"[{\\\"category\\\":\\\"PRIMITIVE\\\",\\\"guid\\\":\\\"string\\\",\\\"createdBy\\\":\\\"string\\\",\\\"updatedBy\\\":\\\"string\\\",\\\"createTime\\\":0,\\\"updateTime\\\":0,\\\"version\\\":0,\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"typeVersion\\\":\\\"string\\\",\\\"serviceType\\\":\\\"string\\\",\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"attributeDefs\\\":[{\\\"name\\\":\\\"string\\\",\\\"typeName\\\":\\\"string\\\",\\\"isOptional\\\":true,\\\"cardinality\\\":\\\"SINGLE\\\",\\\"valuesMinCount\\\":0,\\\"valuesMaxCount\\\":0,\\\"isUnique\\\":true,\\\"isIndexable\\\":true,\\\"includeInNotification\\\":true,\\\"defaultValue\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"searchWeight\\\":0,\\\"indexType\\\":\\\"DEFAULT\\\",\\\"constraints\\\":[{\\\"type\\\":\\\"string\\\",\\\"params\\\":{\\\"property1\\\":{},\\\"property2\\\":{}}}],\\\"options\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"displayName\\\":\\\"string\\\"}],\\\"superTypes\\\":[\\\"string\\\"],\\\"entityTypes\\\":[\\\"string\\\"],\\\"subTypes\\\":[\\\"string\\\"]}]\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGet 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}\")\n .get()\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"GET\", \"/catalog/v1/types/tagdefs/{tagName}\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/tagdefs/{tagName}\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"summary": "Delete Tag Definition",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDelete 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}\")\n .delete(null)\n .build();\n\nResponse 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://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\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\n\nconn = http.client.HTTPSConnection(\"psrc-00000.region.provider.confluent.cloud\")\n\nconn.request(\"DELETE\", \"/catalog/v1/types/tagdefs/{tagName}\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"psrc-00000.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/catalog/v1/types/tagdefs/{tagName}\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://psrc-00000.region.provider.confluent.cloud/catalog/v1/types/tagdefs/{tagName}\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/provider-shared-resources": {
"get": {
"operationId": "listCdxV1ProviderSharedResources",
"summary": "List of Provider Shared Resources",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shared-resources?stream_share=ss-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources?stream_share=ss-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shared-resources?stream_share=ss-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/provider-shared-resources?stream_share=ss-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shared-resources?stream_share=ss-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shared-resources?stream_share=ss-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources?stream_share=ss-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/provider-shared-resources/{id}": {
"get": {
"operationId": "getCdxV1ProviderSharedResource",
"summary": "Read a Provider Shared Resource",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shared-resources/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/provider-shared-resources/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shared-resources/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateCdxV1ProviderSharedResource",
"summary": "Update a Provider Shared Resource",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a provider shared resource.\n\n",
"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.ProviderSharedResourceUpdate"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"crn\":\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic\",\"resources\":[\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\"],\"display_name\":\"Stock Trades\",\"organization_description\":\"ABC Corp is the biggest online retailer\",\"organization_contact\":\"jane.doe@example.com\",\"cloud_cluster\":{\"id\":\"string\",\"environment\":\"string\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"crn\\\":\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic\\\",\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"],\\\"display_name\\\":\\\"Stock Trades\\\",\\\"organization_description\\\":\\\"ABC Corp is the biggest online retailer\\\",\\\"organization_contact\\\":\\\"jane.doe@example.com\\\",\\\"cloud_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shared-resources/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"crn\\\":\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic\\\",\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"],\\\"display_name\\\":\\\"Stock Trades\\\",\\\"organization_description\\\":\\\"ABC Corp is the biggest online retailer\\\",\\\"organization_contact\\\":\\\"jane.doe@example.com\\\",\\\"cloud_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"crn\\\":\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic\\\",\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"],\\\"display_name\\\":\\\"Stock Trades\\\",\\\"organization_description\\\":\\\"ABC Corp is the biggest online retailer\\\",\\\"organization_contact\\\":\\\"jane.doe@example.com\\\",\\\"cloud_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/cdx/v1/provider-shared-resources/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shared-resources/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n crn: 'crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic',\n resources: [\n 'crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic'\n ],\n display_name: 'Stock Trades',\n organization_description: 'ABC Corp is the biggest online retailer',\n organization_contact: 'jane.doe@example.com',\n cloud_cluster: {id: 'string', environment: 'string'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"crn\\\":\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic\\\",\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"],\\\"display_name\\\":\\\"Stock Trades\\\",\\\"organization_description\\\":\\\"ABC Corp is the biggest online retailer\\\",\\\"organization_contact\\\":\\\"jane.doe@example.com\\\",\\\"cloud_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"crn\\\":\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic\\\",\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"],\\\"display_name\\\":\\\"Stock Trades\\\",\\\"organization_description\\\":\\\"ABC Corp is the biggest online retailer\\\",\\\"organization_contact\\\":\\\"jane.doe@example.com\\\",\\\"cloud_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/provider-shared-resources/{id}/images/{file_name}": {
"post": {
"summary": "Upload image for shared resource",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nUpload the image file for the shared resource",
"requestBody": {
"content": {
"image/*": {
"schema": {
"type": "string",
"format": "base64"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: image/*'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\")\n .post(null)\n .addHeader(\"content-type\", \"image/*\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shared-resources/{id}/images/{file_name}\"\n\n\treq, _ := http.NewRequest(\"POST\", url, nil)\n\n\treq.Header.Add(\"content-type\", \"image/*\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = {\n 'content-type': \"image/*\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/cdx/v1/provider-shared-resources/{id}/images/{file_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shared-resources/{id}/images/{file_name}\",\n \"headers\": {\n \"content-type\": \"image/*\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: image/*\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"image/*\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"get": {
"summary": "Get image for shared resource",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturns the image file for the shared resource",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shared-resources/{id}/images/{file_name}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/provider-shared-resources/{id}/images/{file_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shared-resources/{id}/images/{file_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"summary": "Delete the shared resource's image",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDeletes the image file for the shared resource",
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shared-resources/{id}/images/{file_name}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/cdx/v1/provider-shared-resources/{id}/images/{file_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shared-resources/{id}/images/{file_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shared-resources/{id}/images/{file_name}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/provider-shares": {
"get": {
"operationId": "listCdxV1ProviderShares",
"summary": "List of Provider Shares",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shares?shared_resource=sr-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shares?shared_resource=sr-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shares?shared_resource=sr-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/provider-shares?shared_resource=sr-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shares?shared_resource=sr-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shares?shared_resource=sr-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shares?shared_resource=sr-1234&crn=crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic&include_deleted=SOME_BOOLEAN_VALUE\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"summary": "Create a provider share",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nCreates 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"
]
}
]
}
}
}
},
"operationId": "createCdxV1ProviderShare",
"tags": ["Provider Shares (cdx/v1)"],
"security": [
{
"cloud-api-key": []
},
{
"confluent-sts-access-token": []
}
],
"responses": {
"201": {
"description": "Response is the provider share\n",
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/cdx/v1/provider-shares \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"delivery_method\":\"EMAIL\",\"consumer_restriction\":{\"kind\":\"Email\",\"email\":\"user@example.com\"},\"resources\":[\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\"]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"delivery_method\\\":\\\"EMAIL\\\",\\\"consumer_restriction\\\":{\\\"kind\\\":\\\"Email\\\",\\\"email\\\":\\\"user@example.com\\\"},\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shares\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shares\"\n\n\tpayload := strings.NewReader(\"{\\\"delivery_method\\\":\\\"EMAIL\\\",\\\"consumer_restriction\\\":{\\\"kind\\\":\\\"Email\\\",\\\"email\\\":\\\"user@example.com\\\"},\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"delivery_method\\\":\\\"EMAIL\\\",\\\"consumer_restriction\\\":{\\\"kind\\\":\\\"Email\\\",\\\"email\\\":\\\"user@example.com\\\"},\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/cdx/v1/provider-shares\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shares\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n delivery_method: 'EMAIL',\n consumer_restriction: {kind: 'Email', email: 'user@example.com'},\n resources: [\n 'crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic'\n ]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shares\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"delivery_method\\\":\\\"EMAIL\\\",\\\"consumer_restriction\\\":{\\\"kind\\\":\\\"Email\\\",\\\"email\\\":\\\"user@example.com\\\"},\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shares\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"delivery_method\\\":\\\"EMAIL\\\",\\\"consumer_restriction\\\":{\\\"kind\\\":\\\"Email\\\",\\\"email\\\":\\\"user@example.com\\\"},\\\"resources\\\":[\\\"crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic\\\"]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/provider-shares/{id}": {
"get": {
"operationId": "getCdxV1ProviderShare",
"summary": "Read a Provider Share",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shares/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shares/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shares/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/provider-shares/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shares/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shares/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shares/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteCdxV1ProviderShare",
"summary": "Delete a Provider Share",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shares/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shares/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shares/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/cdx/v1/provider-shares/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shares/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shares/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shares/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/provider-shares/{id}:resend": {
"post": {
"summary": "Resend",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nResend provider share",
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/cdx/v1/provider-shares/{id}:resend' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/provider-shares/{id}:resend\")\n .post(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/provider-shares/{id}:resend\"\n\n\treq, _ := http.NewRequest(\"POST\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"POST\", \"/cdx/v1/provider-shares/{id}:resend\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/provider-shares/{id}:resend\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/provider-shares/{id}:resend\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/provider-shares/{id}:resend\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/consumer-shared-resources": {
"get": {
"operationId": "listCdxV1ConsumerSharedResources",
"summary": "List of Consumer Shared Resources",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/consumer-shared-resources?stream_share=ss-1234&include_deleted=SOME_BOOLEAN_VALUE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/consumer-shared-resources?stream_share=ss-1234&include_deleted=SOME_BOOLEAN_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/consumer-shared-resources?stream_share=ss-1234&include_deleted=SOME_BOOLEAN_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/consumer-shared-resources?stream_share=ss-1234&include_deleted=SOME_BOOLEAN_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/consumer-shared-resources?stream_share=ss-1234&include_deleted=SOME_BOOLEAN_VALUE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/consumer-shared-resources?stream_share=ss-1234&include_deleted=SOME_BOOLEAN_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/consumer-shared-resources?stream_share=ss-1234&include_deleted=SOME_BOOLEAN_VALUE\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/consumer-shared-resources/{id}": {
"get": {
"operationId": "getCdxV1ConsumerSharedResource",
"summary": "Read a Consumer Shared Resource",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/consumer-shared-resources/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/consumer-shared-resources/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/consumer-shared-resources/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/consumer-shared-resources/{id}/images/{file_name}": {
"get": {
"summary": "Get image for shared resource",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturns the image file for the shared resource",
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}/images/{file_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}/images/{file_name}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/consumer-shared-resources/{id}/images/{file_name}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/consumer-shared-resources/{id}/images/{file_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/consumer-shared-resources/{id}/images/{file_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}/images/{file_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}/images/{file_name}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/consumer-shared-resources/{id}:network": {
"get": {
"summary": "Get shared resource's network configuration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturns network information of the shared resource",
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}:network' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}:network\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/consumer-shared-resources/{id}:network\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/consumer-shared-resources/{id}:network\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/consumer-shared-resources/{id}:network\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}:network\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/consumer-shared-resources/{id}:network\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/consumer-shares": {
"get": {
"operationId": "listCdxV1ConsumerShares",
"summary": "List of Consumer Shares",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/consumer-shares?shared_resource=sr-1234&include_deleted=SOME_BOOLEAN_VALUE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/consumer-shares?shared_resource=sr-1234&include_deleted=SOME_BOOLEAN_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/consumer-shares?shared_resource=sr-1234&include_deleted=SOME_BOOLEAN_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/consumer-shares?shared_resource=sr-1234&include_deleted=SOME_BOOLEAN_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/consumer-shares?shared_resource=sr-1234&include_deleted=SOME_BOOLEAN_VALUE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/consumer-shares?shared_resource=sr-1234&include_deleted=SOME_BOOLEAN_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/consumer-shares?shared_resource=sr-1234&include_deleted=SOME_BOOLEAN_VALUE\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/consumer-shares/{id}": {
"get": {
"operationId": "getCdxV1ConsumerShare",
"summary": "Read a Consumer Share",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/cdx/v1/consumer-shares/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/consumer-shares/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/consumer-shares/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/consumer-shares/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/consumer-shares/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/consumer-shares/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/consumer-shares/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteCdxV1ConsumerShare",
"summary": "Delete a Consumer Share",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/cdx/v1/consumer-shares/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/consumer-shares/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/consumer-shares/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/cdx/v1/consumer-shares/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/consumer-shares/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/consumer-shares/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/consumer-shares/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/shared-tokens:resources": {
"post": {
"summary": "Validate token to view shared resources",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nValidate 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-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\n",
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/cdx/v1/shared-tokens:resources \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"token\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"token\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/shared-tokens:resources\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/shared-tokens:resources\"\n\n\tpayload := strings.NewReader(\"{\\\"token\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"token\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/cdx/v1/shared-tokens:resources\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/shared-tokens:resources\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({token: 'string'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/shared-tokens:resources\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"token\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/shared-tokens:resources\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"token\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/shared-tokens:redeem": {
"post": {
"summary": "Redeem token",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRedeem 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-name": "cdx.v1.SharedToken",
"operationId": "redeemCdxV1SharedToken",
"tags": ["Shared Tokens (cdx/v1)"],
"security": [
{
"cloud-api-key": []
}
],
"responses": {
"200": {
"description": "Consumer redeems shared token\n",
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/cdx/v1/shared-tokens:redeem \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"token\":\"string\",\"aws_account\":\"000000000000\",\"azure_subscription\":\"00000000-0000-0000-0000-000000000000\",\"gcp_project\":\"string\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"token\\\":\\\"string\\\",\\\"aws_account\\\":\\\"000000000000\\\",\\\"azure_subscription\\\":\\\"00000000-0000-0000-0000-000000000000\\\",\\\"gcp_project\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/shared-tokens:redeem\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/shared-tokens:redeem\"\n\n\tpayload := strings.NewReader(\"{\\\"token\\\":\\\"string\\\",\\\"aws_account\\\":\\\"000000000000\\\",\\\"azure_subscription\\\":\\\"00000000-0000-0000-0000-000000000000\\\",\\\"gcp_project\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"token\\\":\\\"string\\\",\\\"aws_account\\\":\\\"000000000000\\\",\\\"azure_subscription\\\":\\\"00000000-0000-0000-0000-000000000000\\\",\\\"gcp_project\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/cdx/v1/shared-tokens:redeem\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/shared-tokens:redeem\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n token: 'string',\n aws_account: '000000000000',\n azure_subscription: '00000000-0000-0000-0000-000000000000',\n gcp_project: 'string'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/shared-tokens:redeem\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"token\\\":\\\"string\\\",\\\"aws_account\\\":\\\"000000000000\\\",\\\"azure_subscription\\\":\\\"00000000-0000-0000-0000-000000000000\\\",\\\"gcp_project\\\":\\\"string\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/shared-tokens:redeem\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"token\\\":\\\"string\\\",\\\"aws_account\\\":\\\"000000000000\\\",\\\"azure_subscription\\\":\\\"00000000-0000-0000-0000-000000000000\\\",\\\"gcp_project\\\":\\\"string\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/cdx/v1/opt-in": {
"get": {
"summary": "Read the organization's stream sharing opt-in settings",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nReturns the organization's stream sharing opt-in settings.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/cdx/v1/opt-in \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/opt-in\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/opt-in\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/cdx/v1/opt-in\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/opt-in\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/opt-in\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/opt-in\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"summary": "Set the organization's stream sharing opt-in settings",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nUpdates the organization's stream sharing opt-in settings.\n\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url https://api.confluent.cloud/cdx/v1/opt-in \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"stream_share_enabled\":true}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"stream_share_enabled\\\":true}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/cdx/v1/opt-in\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/cdx/v1/opt-in\"\n\n\tpayload := strings.NewReader(\"{\\\"stream_share_enabled\\\":true}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"stream_share_enabled\\\":true}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/cdx/v1/opt-in\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/cdx/v1/opt-in\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({stream_share_enabled: true}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/cdx/v1/opt-in\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"stream_share_enabled\\\":true}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/cdx/v1/opt-in\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"stream_share_enabled\\\":true}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/partner/v2/organizations/{id}": {
"x-request-access-name": "Partner v2",
"get": {
"x-request-access-name": "Partner v2",
"operationId": "getPartnerV2Organization",
"summary": "Read an Organization",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nMake 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 \\\n --url 'https://api.confluent.cloud/partner/v2/organizations/{id}' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/organizations/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/partner/v2/organizations/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/organizations/{id}\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/organizations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/organizations/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nIRestResponse response = client.Execute(request);"
},
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/partner/v2/organizations/{id}' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/organizations/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/partner/v2/organizations/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/organizations/{id}\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/organizations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/organizations/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/partner/v2/organizations": {
"x-request-access-name": "Partner v2",
"get": {
"x-request-access-name": "Partner v2",
"operationId": "listPartnerV2Organizations",
"summary": "List of Organizations",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nRetrieve 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 \\\n --url 'https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode 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\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nIRestResponse response = client.Execute(request);"
},
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/partner/v2/organizations \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/organizations\")\n .get()\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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\"\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/partner/v2/organizations\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/organizations\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/organizations\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/organizations\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/partner/v2/signup": {
"post": {
"summary": "Signup an Organization on behalf of a Customer",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nCreate an organization for a customer. You must pass in either an entitlement object reference (a url to \na previously created entitlement) or entitlement details. If you pass in an entitlement object reference, we will link with the \ncreated entitlement. If you pass in the entitlement details, we will create the entitlement with the organization \nin a single transaction. If you pass in user details (email, given name, and family name), we will\ncreate a user as well. If you do not pass in user details, you MUST call `/partner/v2/signup/activate`\nwith 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"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/partner/v2/signup \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"organization\":{\"name\":\"Acme Organization\",\"sso_config\":{\"kind\":\"AzureSSOConfig\",\"tenant_id\":\"b3a17773-05cc-4431-9560-433fb4613da8\"}},\"user\":{},\"entitlement\":{\"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\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"user\\\":{},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/signup\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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/signup\"\n\n\tpayload := strings.NewReader(\"{\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"user\\\":{},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"user\\\":{},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"POST\", \"/partner/v2/signup\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/signup\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n organization: {\n name: 'Acme Organization',\n sso_config: {kind: 'AzureSSOConfig', tenant_id: 'b3a17773-05cc-4431-9560-433fb4613da8'}\n },\n user: {},\n entitlement: {\n external_id: '1111-2222-3333-4444',\n name: 'Acme Prod Entitlement',\n plan_id: 'confluent-cloud-payg-prod',\n product_id: 'confluent-cloud-kafka-service-azure',\n usage_reporting_id: '1111-2222-3333-4444',\n resource_id: '1111-2222-3333-4444',\n organization: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/signup\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"user\\\":{},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/signup\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nrequest.AddParameter(\"application/json\", \"{\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"user\\\":{},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/partner/v2/signup/activate": {
"post": {
"summary": "Activate an Incomplete Signup",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nCreates a user in the organization previously created in `/partner/v2/signup`. This completes the signup\nprocess if you did not pass in user details to `/partner/v2/signup`. Calling this endpoint if the signup \nprocess 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"
}
}
}
},
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/partner/v2/signup/activate \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"user\":{},\"organization_id\":\"b3a17773-05cc-4431-9560-433fb4613da8\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"user\\\":{},\\\"organization_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/signup/activate\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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/signup/activate\"\n\n\tpayload := strings.NewReader(\"{\\\"user\\\":{},\\\"organization_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"user\\\":{},\\\"organization_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"POST\", \"/partner/v2/signup/activate\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/signup/activate\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({user: {}, organization_id: 'b3a17773-05cc-4431-9560-433fb4613da8'}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/signup/activate\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"user\\\":{},\\\"organization_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/signup/activate\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nrequest.AddParameter(\"application/json\", \"{\\\"user\\\":{},\\\"organization_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/partner/v2/signup/link": {
"post": {
"summary": "Signup a Customer by Linking to an Existing Organization",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nSignup 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"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/partner/v2/signup/link \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"token\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\"organization\":{\"name\":\"Acme Organization\",\"sso_config\":{\"kind\":\"AzureSSOConfig\",\"tenant_id\":\"b3a17773-05cc-4431-9560-433fb4613da8\"}},\"entitlement\":{\"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\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"token\\\":\\\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\\\",\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/partner/v2/signup/link\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .build();\n\nResponse 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/signup/link\"\n\n\tpayload := strings.NewReader(\"{\\\"token\\\":\\\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\\\",\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"token\\\":\\\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\\\",\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"POST\", \"/partner/v2/signup/link\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/partner/v2/signup/link\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',\n organization: {\n name: 'Acme Organization',\n sso_config: {kind: 'AzureSSOConfig', tenant_id: 'b3a17773-05cc-4431-9560-433fb4613da8'}\n },\n entitlement: {\n external_id: '1111-2222-3333-4444',\n name: 'Acme Prod Entitlement',\n plan_id: 'confluent-cloud-payg-prod',\n product_id: 'confluent-cloud-kafka-service-azure',\n usage_reporting_id: '1111-2222-3333-4444',\n resource_id: '1111-2222-3333-4444',\n organization: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/partner/v2/signup/link\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Bearer REPLACE_BEARER_TOKEN\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"token\\\":\\\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\\\",\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/partner/v2/signup/link\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nrequest.AddParameter(\"application/json\", \"{\\\"token\\\":\\\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\\\",\\\"organization\\\":{\\\"name\\\":\\\"Acme Organization\\\",\\\"sso_config\\\":{\\\"kind\\\":\\\"AzureSSOConfig\\\",\\\"tenant_id\\\":\\\"b3a17773-05cc-4431-9560-433fb4613da8\\\"}},\\\"entitlement\\\":{\\\"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\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/networks": {
"get": {
"operationId": "listNetworkingV1Networks",
"summary": "List of Networks",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/networks?spec.display_name=prod-gcp-us-central1,prod-aws-us-east1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&spec.connection_types=peering,privatelink&spec.cidr=10.200.0.0/16&status.phase=PROVISIONING,READY&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/networks?spec.display_name=prod-gcp-us-central1,prod-aws-us-east1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&spec.connection_types=peering,privatelink&spec.cidr=10.200.0.0/16&status.phase=PROVISIONING,READY&environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/networks?spec.display_name=prod-gcp-us-central1,prod-aws-us-east1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&spec.connection_types=peering,privatelink&spec.cidr=10.200.0.0/16&status.phase=PROVISIONING,READY&environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/networks?spec.display_name=prod-gcp-us-central1,prod-aws-us-east1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&spec.connection_types=peering,privatelink&spec.cidr=10.200.0.0/16&status.phase=PROVISIONING,READY&environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/networks?spec.display_name=prod-gcp-us-central1,prod-aws-us-east1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&spec.connection_types=peering,privatelink&spec.cidr=10.200.0.0/16&status.phase=PROVISIONING,READY&environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/networks?spec.display_name=prod-gcp-us-central1,prod-aws-us-east1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&spec.connection_types=peering,privatelink&spec.cidr=10.200.0.0/16&status.phase=PROVISIONING,READY&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/networks?spec.display_name=prod-gcp-us-central1,prod-aws-us-east1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&spec.connection_types=peering,privatelink&spec.cidr=10.200.0.0/16&status.phase=PROVISIONING,READY&environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1Network",
"summary": "Create a Network",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/networks \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-aws-us-east1\",\"cloud\":\"AWS\",\"region\":\"us-east-1\",\"connection_types\":[\"PRIVATELINK\"],\"cidr\":\"10.200.0.0/16\",\"zones\":[\"use1-az1\",\"use1-az2\",\"use1-az3\"],\"zones_info\":[{\"zone_id\":\"use1-az3\",\"cidr\":\"10.20.0.0/27\"},{\"zone_id\":\"use1-az3\",\"cidr\":\"10.20.0.0/27\"},{\"zone_id\":\"use1-az3\",\"cidr\":\"10.20.0.0/27\"}],\"dns_config\":{\"resolution\":\"string\"},\"reserved_cidr\":\"172.20.255.0/24\",\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/networks\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/networks\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/networks\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/networks\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-aws-us-east1',\n cloud: 'AWS',\n region: 'us-east-1',\n connection_types: ['PRIVATELINK'],\n cidr: '10.200.0.0/16',\n zones: ['use1-az1', 'use1-az2', 'use1-az3'],\n zones_info: [\n {zone_id: 'use1-az3', cidr: '10.20.0.0/27'},\n {zone_id: 'use1-az3', cidr: '10.20.0.0/27'},\n {zone_id: 'use1-az3', cidr: '10.20.0.0/27'}\n ],\n dns_config: {resolution: 'string'},\n reserved_cidr: '172.20.255.0/24',\n environment: {id: 'env-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/networks\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/networks\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/networks/{id}": {
"get": {
"operationId": "getNetworkingV1Network",
"summary": "Read a Network",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/networks/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/networks/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/networks/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/networks/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/networks/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/networks/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/networks/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1Network",
"summary": "Update a Network",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a network.\n\n",
"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.NetworkUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/networks/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-aws-us-east1\",\"cloud\":\"AWS\",\"region\":\"us-east-1\",\"connection_types\":[\"PRIVATELINK\"],\"cidr\":\"10.200.0.0/16\",\"zones\":[\"use1-az1\",\"use1-az2\",\"use1-az3\"],\"zones_info\":[{\"zone_id\":\"use1-az3\",\"cidr\":\"10.20.0.0/27\"},{\"zone_id\":\"use1-az3\",\"cidr\":\"10.20.0.0/27\"},{\"zone_id\":\"use1-az3\",\"cidr\":\"10.20.0.0/27\"}],\"dns_config\":{\"resolution\":\"string\"},\"reserved_cidr\":\"172.20.255.0/24\",\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/networks/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/networks/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/networks/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/networks/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-aws-us-east1',\n cloud: 'AWS',\n region: 'us-east-1',\n connection_types: ['PRIVATELINK'],\n cidr: '10.200.0.0/16',\n zones: ['use1-az1', 'use1-az2', 'use1-az3'],\n zones_info: [\n {zone_id: 'use1-az3', cidr: '10.20.0.0/27'},\n {zone_id: 'use1-az3', cidr: '10.20.0.0/27'},\n {zone_id: 'use1-az3', cidr: '10.20.0.0/27'}\n ],\n dns_config: {resolution: 'string'},\n reserved_cidr: '172.20.255.0/24',\n environment: {id: 'env-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/networks/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/networks/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"connection_types\\\":[\\\"PRIVATELINK\\\"],\\\"cidr\\\":\\\"10.200.0.0/16\\\",\\\"zones\\\":[\\\"use1-az1\\\",\\\"use1-az2\\\",\\\"use1-az3\\\"],\\\"zones_info\\\":[{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"},{\\\"zone_id\\\":\\\"use1-az3\\\",\\\"cidr\\\":\\\"10.20.0.0/27\\\"}],\\\"dns_config\\\":{\\\"resolution\\\":\\\"string\\\"},\\\"reserved_cidr\\\":\\\"172.20.255.0/24\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1Network",
"summary": "Delete a Network",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/networks/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/networks/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/networks/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/networks/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/networks/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/networks/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/networks/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/peerings": {
"get": {
"operationId": "listNetworkingV1Peerings",
"summary": "List of Peerings",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/peerings?spec.display_name=prod-peering-uscentral1,prod-peering-use1&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/peerings?spec.display_name=prod-peering-uscentral1,prod-peering-use1&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/peerings?spec.display_name=prod-peering-uscentral1,prod-peering-use1&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/peerings?spec.display_name=prod-peering-uscentral1,prod-peering-use1&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/peerings?spec.display_name=prod-peering-uscentral1,prod-peering-use1&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/peerings?spec.display_name=prod-peering-uscentral1,prod-peering-use1&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/peerings?spec.display_name=prod-peering-uscentral1,prod-peering-use1&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1Peering",
"summary": "Create a Peering",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/peerings \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-peering-use1\",\"cloud\":{\"kind\":\"AwsPeering\",\"account\":\"000000000000\",\"vpc\":\"vpc-00000000000000000\",\"routes\":[\"10.108.16.0/21\"],\"customer_region\":\"us-east-1\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"network\":{\"id\":\"n-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/peerings\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/peerings\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/peerings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/peerings\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-peering-use1',\n cloud: {\n kind: 'AwsPeering',\n account: '000000000000',\n vpc: 'vpc-00000000000000000',\n routes: ['10.108.16.0/21'],\n customer_region: 'us-east-1'\n },\n environment: {id: 'env-00000', environment: 'string'},\n network: {id: 'n-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/peerings\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/peerings\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/peerings/{id}": {
"get": {
"operationId": "getNetworkingV1Peering",
"summary": "Read a Peering",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/peerings/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/peerings/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/peerings/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/peerings/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/peerings/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/peerings/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/peerings/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1Peering",
"summary": "Update a Peering",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a peering.\n\n",
"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.PeeringUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/peerings/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-peering-use1\",\"cloud\":{\"kind\":\"AwsPeering\",\"account\":\"000000000000\",\"vpc\":\"vpc-00000000000000000\",\"routes\":[\"10.108.16.0/21\"],\"customer_region\":\"us-east-1\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"network\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/peerings/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/peerings/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/peerings/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/peerings/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-peering-use1',\n cloud: {\n kind: 'AwsPeering',\n account: '000000000000',\n vpc: 'vpc-00000000000000000',\n routes: ['10.108.16.0/21'],\n customer_region: 'us-east-1'\n },\n environment: {id: 'env-00000', environment: 'string'},\n network: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/peerings/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/peerings/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-peering-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPeering\\\",\\\"account\\\":\\\"000000000000\\\",\\\"vpc\\\":\\\"vpc-00000000000000000\\\",\\\"routes\\\":[\\\"10.108.16.0/21\\\"],\\\"customer_region\\\":\\\"us-east-1\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1Peering",
"summary": "Delete a Peering",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/peerings/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/peerings/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/peerings/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/peerings/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/peerings/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/peerings/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/peerings/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/transit-gateway-attachments": {
"get": {
"operationId": "listNetworkingV1TransitGatewayAttachments",
"summary": "List of Transit Gateway Attachments",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/transit-gateway-attachments?spec.display_name=prod-tgw-use1,prod-tgw-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments?spec.display_name=prod-tgw-use1,prod-tgw-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/transit-gateway-attachments?spec.display_name=prod-tgw-use1,prod-tgw-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/transit-gateway-attachments?spec.display_name=prod-tgw-use1,prod-tgw-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/transit-gateway-attachments?spec.display_name=prod-tgw-use1,prod-tgw-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/transit-gateway-attachments?spec.display_name=prod-tgw-use1,prod-tgw-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments?spec.display_name=prod-tgw-use1,prod-tgw-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1TransitGatewayAttachment",
"summary": "Create a Transit Gateway Attachment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/transit-gateway-attachments \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-tgw-use1\",\"cloud\":{\"kind\":\"AwsTransitGatewayAttachment\",\"ram_share_arn\":\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\",\"transit_gateway_id\":\"tgw-xxxxxxxxxxxxxxxxx\",\"routes\":[\"100.64.0.0/10\",\"10.0.0.0/8\",\"192.168.0.0/16\",\"172.16.0.0/12\"]},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"network\":{\"id\":\"n-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/transit-gateway-attachments\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/transit-gateway-attachments\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/transit-gateway-attachments\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-tgw-use1',\n cloud: {\n kind: 'AwsTransitGatewayAttachment',\n ram_share_arn: 'arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',\n transit_gateway_id: 'tgw-xxxxxxxxxxxxxxxxx',\n routes: ['100.64.0.0/10', '10.0.0.0/8', '192.168.0.0/16', '172.16.0.0/12']\n },\n environment: {id: 'env-00000', environment: 'string'},\n network: {id: 'n-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/transit-gateway-attachments\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/transit-gateway-attachments/{id}": {
"get": {
"operationId": "getNetworkingV1TransitGatewayAttachment",
"summary": "Read a Transit Gateway Attachment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1TransitGatewayAttachment",
"summary": "Update a Transit Gateway Attachment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a transit gateway attachment.\n\n",
"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.TransitGatewayAttachmentUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-tgw-use1\",\"cloud\":{\"kind\":\"AwsTransitGatewayAttachment\",\"ram_share_arn\":\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\",\"transit_gateway_id\":\"tgw-xxxxxxxxxxxxxxxxx\",\"routes\":[\"100.64.0.0/10\",\"10.0.0.0/8\",\"192.168.0.0/16\",\"172.16.0.0/12\"]},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"network\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/transit-gateway-attachments/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/transit-gateway-attachments/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/transit-gateway-attachments/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-tgw-use1',\n cloud: {\n kind: 'AwsTransitGatewayAttachment',\n ram_share_arn: 'arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',\n transit_gateway_id: 'tgw-xxxxxxxxxxxxxxxxx',\n routes: ['100.64.0.0/10', '10.0.0.0/8', '192.168.0.0/16', '172.16.0.0/12']\n },\n environment: {id: 'env-00000', environment: 'string'},\n network: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-tgw-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsTransitGatewayAttachment\\\",\\\"ram_share_arn\\\":\\\"arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\\\",\\\"transit_gateway_id\\\":\\\"tgw-xxxxxxxxxxxxxxxxx\\\",\\\"routes\\\":[\\\"100.64.0.0/10\\\",\\\"10.0.0.0/8\\\",\\\"192.168.0.0/16\\\",\\\"172.16.0.0/12\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1TransitGatewayAttachment",
"summary": "Delete a Transit Gateway Attachment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/private-link-accesses": {
"get": {
"operationId": "listNetworkingV1PrivateLinkAccesses",
"summary": "List of Private Link Accesses",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-accesses?spec.display_name=prod-pl-use1,prod-pl-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-accesses?spec.display_name=prod-pl-use1,prod-pl-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-accesses?spec.display_name=prod-pl-use1,prod-pl-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/private-link-accesses?spec.display_name=prod-pl-use1,prod-pl-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-accesses?spec.display_name=prod-pl-use1,prod-pl-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-accesses?spec.display_name=prod-pl-use1,prod-pl-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-accesses?spec.display_name=prod-pl-use1,prod-pl-usw2&status.phase=PROVISIONING,READY&environment=env-00000&spec.network=n-00000,n-00001\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1PrivateLinkAccess",
"summary": "Create a Private Link Access",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/private-link-accesses \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-pl-use1\",\"cloud\":{\"kind\":\"AwsPrivateLinkAccess\",\"account\":\"000000000000\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"network\":{\"id\":\"n-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-accesses\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-accesses\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/private-link-accesses\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-accesses\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-pl-use1',\n cloud: {kind: 'AwsPrivateLinkAccess', account: '000000000000'},\n environment: {id: 'env-00000', environment: 'string'},\n network: {id: 'n-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-accesses\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-accesses\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/private-link-accesses/{id}": {
"get": {
"operationId": "getNetworkingV1PrivateLinkAccess",
"summary": "Read a Private Link Access",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-accesses/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-accesses/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/private-link-accesses/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-accesses/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1PrivateLinkAccess",
"summary": "Update a Private Link Access",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a private link access.\n\n",
"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.PrivateLinkAccessUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-accesses/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-pl-use1\",\"cloud\":{\"kind\":\"AwsPrivateLinkAccess\",\"account\":\"000000000000\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"network\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-accesses/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/private-link-accesses/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-accesses/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-pl-use1',\n cloud: {kind: 'AwsPrivateLinkAccess', account: '000000000000'},\n environment: {id: 'env-00000', environment: 'string'},\n network: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-pl-use1\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAccess\\\",\\\"account\\\":\\\"000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1PrivateLinkAccess",
"summary": "Delete a Private Link Access",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-accesses/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-accesses/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/private-link-accesses/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-accesses/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-accesses/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/network-link-services": {
"get": {
"operationId": "listNetworkingV1NetworkLinkServices",
"summary": "List of Network Link Services",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-services?spec.display_name=prod-net-1-nls,dev-net-1-nls&status.phase=READY&environment=env-00000&spec.network=n-00000,n-00001' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-services?spec.display_name=prod-net-1-nls,dev-net-1-nls&status.phase=READY&environment=env-00000&spec.network=n-00000,n-00001\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-services?spec.display_name=prod-net-1-nls,dev-net-1-nls&status.phase=READY&environment=env-00000&spec.network=n-00000,n-00001\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/network-link-services?spec.display_name=prod-net-1-nls,dev-net-1-nls&status.phase=READY&environment=env-00000&spec.network=n-00000,n-00001\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-services?spec.display_name=prod-net-1-nls,dev-net-1-nls&status.phase=READY&environment=env-00000&spec.network=n-00000,n-00001\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-services?spec.display_name=prod-net-1-nls,dev-net-1-nls&status.phase=READY&environment=env-00000&spec.network=n-00000,n-00001\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-services?spec.display_name=prod-net-1-nls,dev-net-1-nls&status.phase=READY&environment=env-00000&spec.network=n-00000,n-00001\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1NetworkLinkService",
"summary": "Create a Network Link Service",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/network-link-services \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-net-1-nls\",\"description\":\"Allow connections from analytics hub\",\"accept\":{\"environments\":[\"string\"],\"networks\":[\"string\"]},\"environment\":{\"id\":\"env-00000\"},\"network\":{\"id\":\"n-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-services\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-services\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/network-link-services\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-services\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-net-1-nls',\n description: 'Allow connections from analytics hub',\n accept: {environments: ['string'], networks: ['string']},\n environment: {id: 'env-00000'},\n network: {id: 'n-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-services\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-services\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/network-link-services/{id}": {
"get": {
"operationId": "getNetworkingV1NetworkLinkService",
"summary": "Read a Network Link Service",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-services/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-services/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-services/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/network-link-services/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-services/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-services/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-services/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1NetworkLinkService",
"summary": "Update a Network Link Service",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a network link service.\n\n",
"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.NetworkLinkServiceUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-services/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-net-1-nls\",\"description\":\"Allow connections from analytics hub\",\"accept\":{\"environments\":[\"string\"],\"networks\":[\"string\"]},\"environment\":{\"id\":\"env-00000\"},\"network\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-services/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-services/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/network-link-services/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-services/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-net-1-nls',\n description: 'Allow connections from analytics hub',\n accept: {environments: ['string'], networks: ['string']},\n environment: {id: 'env-00000'},\n network: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-services/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-services/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nls\\\",\\\"description\\\":\\\"Allow connections from analytics hub\\\",\\\"accept\\\":{\\\"environments\\\":[\\\"string\\\"],\\\"networks\\\":[\\\"string\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1NetworkLinkService",
"summary": "Delete a Network Link Service",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-services/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-services/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-services/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/network-link-services/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-services/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-services/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-services/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/network-link-endpoints": {
"get": {
"operationId": "listNetworkingV1NetworkLinkEndpoints",
"summary": "List of Network Link Endpoints",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-endpoints?spec.display_name=prod-net-1-nle,dev-net-1-nle&status.phase=READY,PENDING_ACCEPT&environment=env-00000&spec.network=n-00000,n-00001&spec.network_link_service=nls-abcde,nls-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-endpoints?spec.display_name=prod-net-1-nle,dev-net-1-nle&status.phase=READY,PENDING_ACCEPT&environment=env-00000&spec.network=n-00000,n-00001&spec.network_link_service=nls-abcde,nls-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-endpoints?spec.display_name=prod-net-1-nle,dev-net-1-nle&status.phase=READY,PENDING_ACCEPT&environment=env-00000&spec.network=n-00000,n-00001&spec.network_link_service=nls-abcde,nls-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/network-link-endpoints?spec.display_name=prod-net-1-nle,dev-net-1-nle&status.phase=READY,PENDING_ACCEPT&environment=env-00000&spec.network=n-00000,n-00001&spec.network_link_service=nls-abcde,nls-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-endpoints?spec.display_name=prod-net-1-nle,dev-net-1-nle&status.phase=READY,PENDING_ACCEPT&environment=env-00000&spec.network=n-00000,n-00001&spec.network_link_service=nls-abcde,nls-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-endpoints?spec.display_name=prod-net-1-nle,dev-net-1-nle&status.phase=READY,PENDING_ACCEPT&environment=env-00000&spec.network=n-00000,n-00001&spec.network_link_service=nls-abcde,nls-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-endpoints?spec.display_name=prod-net-1-nle,dev-net-1-nle&status.phase=READY,PENDING_ACCEPT&environment=env-00000&spec.network=n-00000,n-00001&spec.network_link_service=nls-abcde,nls-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1NetworkLinkEndpoint",
"summary": "Create a Network Link Endpoint",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/network-link-endpoints \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-net-1-nle\",\"description\":\"Connect to Network - analytics hub\",\"environment\":{\"id\":\"env-00000\"},\"network\":{\"id\":\"n-00000\",\"environment\":\"string\"},\"network_link_service\":{\"id\":\"nls-abcde\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"nls-abcde\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-endpoints\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-endpoints\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"nls-abcde\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"nls-abcde\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/network-link-endpoints\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-endpoints\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-net-1-nle',\n description: 'Connect to Network - analytics hub',\n environment: {id: 'env-00000'},\n network: {id: 'n-00000', environment: 'string'},\n network_link_service: {id: 'nls-abcde', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-endpoints\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"nls-abcde\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-endpoints\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"nls-abcde\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/network-link-endpoints/{id}": {
"get": {
"operationId": "getNetworkingV1NetworkLinkEndpoint",
"summary": "Read a Network Link Endpoint",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-endpoints/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/network-link-endpoints/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-endpoints/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1NetworkLinkEndpoint",
"summary": "Update a Network Link Endpoint",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a network link endpoint.\n\n",
"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.NetworkLinkEndpointUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-net-1-nle\",\"description\":\"Connect to Network - analytics hub\",\"environment\":{\"id\":\"env-00000\"},\"network\":{\"id\":\"string\",\"environment\":\"string\"},\"network_link_service\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-endpoints/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/network-link-endpoints/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-endpoints/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-net-1-nle',\n description: 'Connect to Network - analytics hub',\n environment: {id: 'env-00000'},\n network: {id: 'string', environment: 'string'},\n network_link_service: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-net-1-nle\\\",\\\"description\\\":\\\"Connect to Network - analytics hub\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"network_link_service\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1NetworkLinkEndpoint",
"summary": "Delete a Network Link Endpoint",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-endpoints/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/network-link-endpoints/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-endpoints/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/network-link-service-associations": {
"get": {
"operationId": "listNetworkingV1NetworkLinkServiceAssociations",
"summary": "List of Network Link Service Associations",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-service-associations?status.phase=READY,PENDING_ACCEPT&spec.network_link_service=nls-abcde&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-service-associations?status.phase=READY,PENDING_ACCEPT&spec.network_link_service=nls-abcde&environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-service-associations?status.phase=READY,PENDING_ACCEPT&spec.network_link_service=nls-abcde&environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/network-link-service-associations?status.phase=READY,PENDING_ACCEPT&spec.network_link_service=nls-abcde&environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-service-associations?status.phase=READY,PENDING_ACCEPT&spec.network_link_service=nls-abcde&environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-service-associations?status.phase=READY,PENDING_ACCEPT&spec.network_link_service=nls-abcde&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-service-associations?status.phase=READY,PENDING_ACCEPT&spec.network_link_service=nls-abcde&environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/network-link-service-associations/{id}": {
"get": {
"operationId": "getNetworkingV1NetworkLinkServiceAssociation",
"summary": "Read a Network Link Service Association",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/network-link-service-associations/{id}?spec.network_link_service=nls-abcde&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/network-link-service-associations/{id}?spec.network_link_service=nls-abcde&environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/network-link-service-associations/{id}?spec.network_link_service=nls-abcde&environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/network-link-service-associations/{id}?spec.network_link_service=nls-abcde&environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/network-link-service-associations/{id}?spec.network_link_service=nls-abcde&environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/network-link-service-associations/{id}?spec.network_link_service=nls-abcde&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/network-link-service-associations/{id}?spec.network_link_service=nls-abcde&environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/ip-addresses": {
"get": {
"operationId": "listNetworkingV1IpAddresses",
"summary": "List of IP Addresses",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRelated guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/ip-addresses?cloud=GCP,AWS®ion=us-central1,us-east-1&services=KAFKA,CONNECT&address_type=INGRESS,EGRESS' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/ip-addresses?cloud=GCP,AWS®ion=us-central1,us-east-1&services=KAFKA,CONNECT&address_type=INGRESS,EGRESS\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/ip-addresses?cloud=GCP,AWS®ion=us-central1,us-east-1&services=KAFKA,CONNECT&address_type=INGRESS,EGRESS\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/ip-addresses?cloud=GCP,AWS®ion=us-central1,us-east-1&services=KAFKA,CONNECT&address_type=INGRESS,EGRESS\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/ip-addresses?cloud=GCP,AWS®ion=us-central1,us-east-1&services=KAFKA,CONNECT&address_type=INGRESS,EGRESS\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/ip-addresses?cloud=GCP,AWS®ion=us-central1,us-east-1&services=KAFKA,CONNECT&address_type=INGRESS,EGRESS\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/ip-addresses?cloud=GCP,AWS®ion=us-central1,us-east-1&services=KAFKA,CONNECT&address_type=INGRESS,EGRESS\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/private-link-attachments": {
"get": {
"operationId": "listNetworkingV1PrivateLinkAttachments",
"summary": "List of Private Link Attachments",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-attachments?spec.display_name=prod-gcp-us-central1,prod-aws-useast1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&status.phase=PROVISIONING,READY&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachments?spec.display_name=prod-gcp-us-central1,prod-aws-useast1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&status.phase=PROVISIONING,READY&environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachments?spec.display_name=prod-gcp-us-central1,prod-aws-useast1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&status.phase=PROVISIONING,READY&environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/private-link-attachments?spec.display_name=prod-gcp-us-central1,prod-aws-useast1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&status.phase=PROVISIONING,READY&environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachments?spec.display_name=prod-gcp-us-central1,prod-aws-useast1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&status.phase=PROVISIONING,READY&environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachments?spec.display_name=prod-gcp-us-central1,prod-aws-useast1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&status.phase=PROVISIONING,READY&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachments?spec.display_name=prod-gcp-us-central1,prod-aws-useast1&spec.cloud=GCP,AWS&spec.region=us-central1,us-east-1&status.phase=PROVISIONING,READY&environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1PrivateLinkAttachment",
"summary": "Create a Private Link Attachment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/private-link-attachments \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-aws-us-east1\",\"cloud\":\"AWS\",\"region\":\"us-east-1\",\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachments\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachments\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/private-link-attachments\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachments\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-aws-us-east1',\n cloud: 'AWS',\n region: 'us-east-1',\n environment: {id: 'env-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachments\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachments\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/private-link-attachments/{id}": {
"get": {
"operationId": "getNetworkingV1PrivateLinkAttachment",
"summary": "Read a Private Link Attachment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-attachments/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachments/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/private-link-attachments/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachments/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1PrivateLinkAttachment",
"summary": "Update a Private Link Attachment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a private link attachment.\n\n",
"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.PrivateLinkAttachmentUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-attachments/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-aws-us-east1\",\"cloud\":\"AWS\",\"region\":\"us-east-1\",\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachments/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/private-link-attachments/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachments/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-aws-us-east1',\n cloud: 'AWS',\n region: 'us-east-1',\n environment: {id: 'env-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-aws-us-east1\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1PrivateLinkAttachment",
"summary": "Delete a Private Link Attachment",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-attachments/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachments/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/private-link-attachments/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachments/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachments/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/private-link-attachment-connections": {
"get": {
"operationId": "listNetworkingV1PrivateLinkAttachmentConnections",
"summary": "List of Private Link Attachment Connections",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-attachment-connections?environment=env-00000&spec.private_link_attachment=platt-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections?environment=env-00000&spec.private_link_attachment=platt-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachment-connections?environment=env-00000&spec.private_link_attachment=platt-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/private-link-attachment-connections?environment=env-00000&spec.private_link_attachment=platt-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachment-connections?environment=env-00000&spec.private_link_attachment=platt-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachment-connections?environment=env-00000&spec.private_link_attachment=platt-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections?environment=env-00000&spec.private_link_attachment=platt-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1PrivateLinkAttachmentConnection",
"summary": "Create a Private Link Attachment Connection",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/private-link-attachment-connections \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-gcp-us-central1-a\",\"cloud\":{\"kind\":\"AwsPrivateLinkAttachmentConnection\",\"vpc_endpoint_id\":\"vpce-00000000000000000\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"private_link_attachment\":{\"id\":\"platt-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"platt-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachment-connections\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"platt-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"platt-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/private-link-attachment-connections\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachment-connections\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-gcp-us-central1-a',\n cloud: {\n kind: 'AwsPrivateLinkAttachmentConnection',\n vpc_endpoint_id: 'vpce-00000000000000000'\n },\n environment: {id: 'env-00000', environment: 'string'},\n private_link_attachment: {id: 'platt-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachment-connections\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"platt-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"platt-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/private-link-attachment-connections/{id}": {
"get": {
"operationId": "getNetworkingV1PrivateLinkAttachmentConnection",
"summary": "Read a Private Link Attachment Connection",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1PrivateLinkAttachmentConnection",
"summary": "Update a Private Link Attachment Connection",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a private link attachment connection.\n\n",
"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.PrivateLinkAttachmentConnectionUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-gcp-us-central1-a\",\"cloud\":{\"kind\":\"AwsPrivateLinkAttachmentConnection\",\"vpc_endpoint_id\":\"vpce-00000000000000000\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"private_link_attachment\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachment-connections/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/private-link-attachment-connections/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachment-connections/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-gcp-us-central1-a',\n cloud: {\n kind: 'AwsPrivateLinkAttachmentConnection',\n vpc_endpoint_id: 'vpce-00000000000000000'\n },\n environment: {id: 'env-00000', environment: 'string'},\n private_link_attachment: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gcp-us-central1-a\\\",\\\"cloud\\\":{\\\"kind\\\":\\\"AwsPrivateLinkAttachmentConnection\\\",\\\"vpc_endpoint_id\\\":\\\"vpce-00000000000000000\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"private_link_attachment\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1PrivateLinkAttachmentConnection",
"summary": "Delete a Private Link Attachment Connection",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/identity-providers": {
"get": {
"operationId": "listIamV2IdentityProviders",
"summary": "List of Identity Providers",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/iam/v2/identity-providers \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/identity-providers\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createIamV2IdentityProvider",
"summary": "Create an Identity Provider",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/iam/v2/identity-providers \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"My OIDC Provider\",\"description\":\"string\",\"identity_claim\":\"claims.sub\",\"issuer\":\"https://login.microsoftonline.com/{tenantid}/v2.0\",\"jwks_uri\":\"https://login.microsoftonline.com/common/discovery/v2.0/keys\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/identity-providers\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'My OIDC Provider',\n description: 'string',\n identity_claim: 'claims.sub',\n issuer: 'https://login.microsoftonline.com/{tenantid}/v2.0',\n jwks_uri: 'https://login.microsoftonline.com/common/discovery/v2.0/keys'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/identity-providers/{id}": {
"get": {
"operationId": "getIamV2IdentityProvider",
"summary": "Read an Identity Provider",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/identity-providers/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateIamV2IdentityProvider",
"summary": "Update an Identity Provider",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an identity provider.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"My OIDC Provider\",\"description\":\"string\",\"identity_claim\":\"claims.sub\",\"issuer\":\"https://login.microsoftonline.com/{tenantid}/v2.0\",\"jwks_uri\":\"https://login.microsoftonline.com/common/discovery/v2.0/keys\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/identity-providers/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'My OIDC Provider',\n description: 'string',\n identity_claim: 'claims.sub',\n issuer: 'https://login.microsoftonline.com/{tenantid}/v2.0',\n jwks_uri: 'https://login.microsoftonline.com/common/discovery/v2.0/keys'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"My OIDC Provider\\\",\\\"description\\\":\\\"string\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"issuer\\\":\\\"https://login.microsoftonline.com/{tenantid}/v2.0\\\",\\\"jwks_uri\\\":\\\"https://login.microsoftonline.com/common/discovery/v2.0/keys\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2IdentityProvider",
"summary": "Delete an Identity Provider",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/identity-providers/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/identity-providers/{provider_id}/jwks": {
"patch": {
"summary": "Refresh a provider's JWKS",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to refresh the provider's JWKS\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/jwks' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"jwks_status\":\"REFRESHED\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"jwks_status\\\":\\\"REFRESHED\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/jwks\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{provider_id}/jwks\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"jwks_status\\\":\\\"REFRESHED\\\"}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"jwks_status\\\":\\\"REFRESHED\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/identity-providers/{provider_id}/jwks\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{provider_id}/jwks\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({spec: {jwks_status: 'REFRESHED'}}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/jwks\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"jwks_status\\\":\\\"REFRESHED\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/jwks\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"jwks_status\\\":\\\"REFRESHED\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/identity-providers/{provider_id}/identity-pools": {
"get": {
"operationId": "listIamV2IdentityPools",
"summary": "List of Identity Pools",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{provider_id}/identity-pools\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/identity-providers/{provider_id}/identity-pools\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{provider_id}/identity-pools\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createIamV2IdentityPool",
"summary": "Create an Identity Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools?assigned_resource_owner=u-a83k9b' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"My Identity Pool\",\"description\":\"Prod Access to Kafka clusters to Release Engineering\",\"identity_claim\":\"claims.sub\",\"filter\":\"claims.aud==\\\"confluent\\\" && claims.group!=\\\"invalid_group\\\"\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools?assigned_resource_owner=u-a83k9b\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{provider_id}/identity-pools?assigned_resource_owner=u-a83k9b\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/identity-providers/{provider_id}/identity-pools?assigned_resource_owner=u-a83k9b\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{provider_id}/identity-pools?assigned_resource_owner=u-a83k9b\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'My Identity Pool',\n description: 'Prod Access to Kafka clusters to Release Engineering',\n identity_claim: 'claims.sub',\n filter: 'claims.aud==\"confluent\" && claims.group!=\"invalid_group\"'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools?assigned_resource_owner=u-a83k9b\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools?assigned_resource_owner=u-a83k9b\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/identity-providers/{provider_id}/identity-pools/{id}": {
"get": {
"operationId": "getIamV2IdentityPool",
"summary": "Read an Identity Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateIamV2IdentityPool",
"summary": "Update an Identity Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an identity pool.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"My Identity Pool\",\"description\":\"Prod Access to Kafka clusters to Release Engineering\",\"identity_claim\":\"claims.sub\",\"filter\":\"claims.aud==\\\"confluent\\\" && claims.group!=\\\"invalid_group\\\"\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'My Identity Pool',\n description: 'Prod Access to Kafka clusters to Release Engineering',\n identity_claim: 'claims.sub',\n filter: 'claims.aud==\"confluent\" && claims.group!=\"invalid_group\"'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"identity_claim\\\":\\\"claims.sub\\\",\\\"filter\\\":\\\"claims.aud==\\\\\\\"confluent\\\\\\\" && claims.group!=\\\\\\\"invalid_group\\\\\\\"\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2IdentityPool",
"summary": "Delete an Identity Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/sts/v1/oauth2/token": {
"post": {
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nUse this operation to exchange an access token (JWT) issued by an external identity provider for\nan access token (JWT) issued by Confluent.This enables the use of external identities\nto access Confluent Cloud APIs.\n",
"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-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\n",
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/sts/v1/oauth2/token \\\n --header 'content-type: application/x-www-form-urlencoded' \\\n --data grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Atoken-exchange \\\n --data subject_token=test_jwt_token \\\n --data identity_pool_id=pool_1 \\\n --data subject_token_type=urn%3Aietf%3Aparams%3Aoauth%3Atoken-type%3Ajwt \\\n --data requested_token_type=urn%3Aietf%3Aparams%3Aoauth%3Atoken-type%3Aaccess_token \\\n --data expires_in=900"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/x-www-form-urlencoded\");\nRequestBody body = RequestBody.create(mediaType, \"grant_type=urn%253Aietf%253Aparams%253Aoauth%253Agrant-type%253Atoken-exchange&subject_token=test_jwt_token&identity_pool_id=pool_1&subject_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Ajwt&requested_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Aaccess_token&expires_in=900\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/sts/v1/oauth2/token\")\n .post(body)\n .addHeader(\"content-type\", \"application/x-www-form-urlencoded\")\n .build();\n\nResponse 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/sts/v1/oauth2/token\"\n\n\tpayload := strings.NewReader(\"grant_type=urn%253Aietf%253Aparams%253Aoauth%253Agrant-type%253Atoken-exchange&subject_token=test_jwt_token&identity_pool_id=pool_1&subject_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Ajwt&requested_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Aaccess_token&expires_in=900\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/x-www-form-urlencoded\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"grant_type=urn%253Aietf%253Aparams%253Aoauth%253Agrant-type%253Atoken-exchange&subject_token=test_jwt_token&identity_pool_id=pool_1&subject_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Ajwt&requested_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Aaccess_token&expires_in=900\"\n\nheaders = { 'content-type': \"application/x-www-form-urlencoded\" }\n\nconn.request(\"POST\", \"/sts/v1/oauth2/token\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const qs = require(\"querystring\");\nconst http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sts/v1/oauth2/token\",\n \"headers\": {\n \"content-type\": \"application/x-www-form-urlencoded\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(qs.stringify({\n grant_type: 'urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Atoken-exchange',\n subject_token: 'test_jwt_token',\n identity_pool_id: 'pool_1',\n subject_token_type: 'urn%3Aietf%3Aparams%3Aoauth%3Atoken-type%3Ajwt',\n requested_token_type: 'urn%3Aietf%3Aparams%3Aoauth%3Atoken-type%3Aaccess_token',\n expires_in: '900'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/sts/v1/oauth2/token\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/x-www-form-urlencoded\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"grant_type=urn%253Aietf%253Aparams%253Aoauth%253Agrant-type%253Atoken-exchange&subject_token=test_jwt_token&identity_pool_id=pool_1&subject_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Ajwt&requested_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Aaccess_token&expires_in=900\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/sts/v1/oauth2/token\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/x-www-form-urlencoded\");\nrequest.AddParameter(\"application/x-www-form-urlencoded\", \"grant_type=urn%253Aietf%253Aparams%253Aoauth%253Agrant-type%253Atoken-exchange&subject_token=test_jwt_token&identity_pool_id=pool_1&subject_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Ajwt&requested_token_type=urn%253Aietf%253Aparams%253Aoauth%253Atoken-type%253Aaccess_token&expires_in=900\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/kafka-quotas/v1/client-quotas": {
"get": {
"operationId": "listKafkaQuotasV1ClientQuotas",
"summary": "List of Client Quotas",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/kafka-quotas/v1/client-quotas?spec.cluster=lkc-xxxxx&environment=env-xxxxx' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas?spec.cluster=lkc-xxxxx&environment=env-xxxxx\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/kafka-quotas/v1/client-quotas?spec.cluster=lkc-xxxxx&environment=env-xxxxx\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka-quotas/v1/client-quotas?spec.cluster=lkc-xxxxx&environment=env-xxxxx\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka-quotas/v1/client-quotas?spec.cluster=lkc-xxxxx&environment=env-xxxxx\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/kafka-quotas/v1/client-quotas?spec.cluster=lkc-xxxxx&environment=env-xxxxx\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas?spec.cluster=lkc-xxxxx&environment=env-xxxxx\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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"
}
}
}
}
}
}
},
"operationId": "createKafkaQuotasV1ClientQuota",
"summary": "Create a Client Quota",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/kafka-quotas/v1/client-quotas \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"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\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"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\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/kafka-quotas/v1/client-quotas\"\n\n\tpayload := strings.NewReader(\"{\\\"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\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"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\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/kafka-quotas/v1/client-quotas\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka-quotas/v1/client-quotas\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'QuotaForSA1',\n description: 'This quota defines limits on how much the target principals can use cluster lkc-xxxxx',\n throughput: {ingress_byte_rate: '5', egress_byte_rate: '5'},\n cluster: {id: 'lkc-xxxxx'},\n principals: [{id: 'sa-xxxxx'}],\n environment: {id: 'env-xxxxx'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/kafka-quotas/v1/client-quotas\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"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\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"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\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/kafka-quotas/v1/client-quotas/{id}": {
"get": {
"operationId": "getKafkaQuotasV1ClientQuota",
"summary": "Read a Client Quota",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/kafka-quotas/v1/client-quotas/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/kafka-quotas/v1/client-quotas/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka-quotas/v1/client-quotas/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateKafkaQuotasV1ClientQuota",
"summary": "Update a Client Quota",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a client quota.\n\n",
"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.ClientQuotaUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"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\":\"string\",\"environment\":\"string\"},\"principals\":[{\"id\":\"string\"}],\"environment\":{\"id\":\"env-00000\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"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\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"principals\\\":[{\\\"id\\\":\\\"string\\\"}],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/kafka-quotas/v1/client-quotas/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"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\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"principals\\\":[{\\\"id\\\":\\\"string\\\"}],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"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\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"principals\\\":[{\\\"id\\\":\\\"string\\\"}],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/kafka-quotas/v1/client-quotas/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka-quotas/v1/client-quotas/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'QuotaForSA1',\n description: 'This quota defines limits on how much the target principals can use cluster lkc-xxxxx',\n throughput: {ingress_byte_rate: '5', egress_byte_rate: '5'},\n cluster: {id: 'string', environment: 'string'},\n principals: [{id: 'string'}],\n environment: {id: 'env-00000'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"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\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"principals\\\":[{\\\"id\\\":\\\"string\\\"}],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"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\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"},\\\"principals\\\":[{\\\"id\\\":\\\"string\\\"}],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteKafkaQuotasV1ClientQuota",
"summary": "Delete a Client Quota",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/kafka-quotas/v1/client-quotas/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/kafka-quotas/v1/client-quotas/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/kafka-quotas/v1/client-quotas/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/byok/v1/keys": {
"get": {
"operationId": "listByokV1Keys",
"summary": "List of Keys",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve a sorted, filtered, paginated list of all keys.",
"parameters": [
{
"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": "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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/byok/v1/keys?provider=AWS&state=IN_USE' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/byok/v1/keys?provider=AWS&state=IN_USE\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/byok/v1/keys?provider=AWS&state=IN_USE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/byok/v1/keys?provider=AWS&state=IN_USE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/byok/v1/keys?provider=AWS&state=IN_USE\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/byok/v1/keys?provider=AWS&state=IN_USE\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/byok/v1/keys?provider=AWS&state=IN_USE\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createByokV1Key",
"summary": "Create a Key",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/byok/v1/keys \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"key\":{\"key_arn\":\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\",\"kind\":\"AwsKey\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"key\\\":{\\\"key_arn\\\":\\\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\\\",\\\"kind\\\":\\\"AwsKey\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/byok/v1/keys\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/byok/v1/keys\"\n\n\tpayload := strings.NewReader(\"{\\\"key\\\":{\\\"key_arn\\\":\\\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\\\",\\\"kind\\\":\\\"AwsKey\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"key\\\":{\\\"key_arn\\\":\\\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\\\",\\\"kind\\\":\\\"AwsKey\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/byok/v1/keys\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/byok/v1/keys\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n key: {\n key_arn: 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',\n kind: 'AwsKey'\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/byok/v1/keys\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"key\\\":{\\\"key_arn\\\":\\\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\\\",\\\"kind\\\":\\\"AwsKey\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/byok/v1/keys\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"key\\\":{\\\"key_arn\\\":\\\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\\\",\\\"kind\\\":\\\"AwsKey\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/byok/v1/keys/{id}": {
"get": {
"operationId": "getByokV1Key",
"summary": "Read a Key",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
]
}
]
}
}
},
"headers": {
"X-Request-Id": {
"schema": {
"type": "string"
},
"description": "The unique identifier for the API request."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "The maximum number of requests you're permitted to make per time period."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "The number of requests remaining in the current rate limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "The relative time in seconds until the current rate-limit window resets. \n \n**Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues."
}
}
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"401": {
"$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 \\\n --url 'https://api.confluent.cloud/byok/v1/keys/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/byok/v1/keys/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/byok/v1/keys/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/byok/v1/keys/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/byok/v1/keys/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/byok/v1/keys/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/byok/v1/keys/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteByokV1Key",
"summary": "Delete a Key",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/byok/v1/keys/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/byok/v1/keys/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/byok/v1/keys/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/byok/v1/keys/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/byok/v1/keys/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/byok/v1/keys/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/byok/v1/keys/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/billing/v1/costs": {
"get": {
"operationId": "listBillingV1Costs",
"summary": "List of Costs",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/billing/v1/costs?start_date=2022-10-12&end_date=2022-10-15' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/billing/v1/costs?start_date=2022-10-12&end_date=2022-10-15\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/billing/v1/costs?start_date=2022-10-12&end_date=2022-10-15\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/billing/v1/costs?start_date=2022-10-12&end_date=2022-10-15\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/billing/v1/costs?start_date=2022-10-12&end_date=2022-10-15\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/billing/v1/costs?start_date=2022-10-12&end_date=2022-10-15\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/billing/v1/costs?start_date=2022-10-12&end_date=2022-10-15\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/sso/group-mappings": {
"get": {
"operationId": "listIamV2SsoGroupMappings",
"summary": "List of Group Mappings",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/iam/v2/sso/group-mappings \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/sso/group-mappings\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/sso/group-mappings\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/sso/group-mappings\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/sso/group-mappings\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/sso/group-mappings\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/sso/group-mappings\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createIamV2SsoGroupMapping",
"summary": "Create a Group Mapping",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/iam/v2/sso/group-mappings \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"Application Developers\",\"description\":\"Admin access to production environment for Engineering\",\"filter\":\"\\\"kafka\\\" in groups && \\\"all\\\" in groups || \\\"everyone\\\" in groups\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/sso/group-mappings\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/sso/group-mappings\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/sso/group-mappings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/sso/group-mappings\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'Application Developers',\n description: 'Admin access to production environment for Engineering',\n filter: '\"kafka\" in groups && \"all\" in groups || \"everyone\" in groups'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/sso/group-mappings\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/sso/group-mappings\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/sso/group-mappings/{id}": {
"get": {
"operationId": "getIamV2SsoGroupMapping",
"summary": "Read a Group Mapping",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/sso/group-mappings/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/sso/group-mappings/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/sso/group-mappings/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateIamV2SsoGroupMapping",
"summary": "Update a Group Mapping",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a group mapping.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"Application Developers\",\"description\":\"Admin access to production environment for Engineering\",\"filter\":\"\\\"kafka\\\" in groups && \\\"all\\\" in groups || \\\"everyone\\\" in groups\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/sso/group-mappings/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/iam/v2/sso/group-mappings/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/sso/group-mappings/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'Application Developers',\n description: 'Admin access to production environment for Engineering',\n filter: '\"kafka\" in groups && \"all\" in groups || \"everyone\" in groups'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"Application Developers\\\",\\\"description\\\":\\\"Admin access to production environment for Engineering\\\",\\\"filter\\\":\\\"\\\\\\\"kafka\\\\\\\" in groups && \\\\\\\"all\\\\\\\" in groups || \\\\\\\"everyone\\\\\\\" in groups\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2SsoGroupMapping",
"summary": "Delete a Group Mapping",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/sso/group-mappings/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/sso/group-mappings/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/sso/group-mappings/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/sso/group-mappings/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/fcpm/v2/compute-pools": {
"get": {
"operationId": "listFcpmV2ComputePools",
"summary": "List of Compute Pools",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/fcpm/v2/compute-pools?spec.region=us-west-1&environment=env-00000&spec.network=n-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/fcpm/v2/compute-pools?spec.region=us-west-1&environment=env-00000&spec.network=n-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/fcpm/v2/compute-pools?spec.region=us-west-1&environment=env-00000&spec.network=n-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/fcpm/v2/compute-pools?spec.region=us-west-1&environment=env-00000&spec.network=n-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/fcpm/v2/compute-pools?spec.region=us-west-1&environment=env-00000&spec.network=n-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/fcpm/v2/compute-pools?spec.region=us-west-1&environment=env-00000&spec.network=n-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/fcpm/v2/compute-pools?spec.region=us-west-1&environment=env-00000&spec.network=n-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createFcpmV2ComputePool",
"summary": "Create a Compute Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/fcpm/v2/compute-pools \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"flink_compute_pool_0\",\"cloud\":\"AWS\",\"region\":\"us-west-1\",\"max_cfu\":5,\"enable_ai\":false,\"environment\":{\"id\":\"env-00000\"},\"network\":{\"id\":\"n-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/fcpm/v2/compute-pools\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/fcpm/v2/compute-pools\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/fcpm/v2/compute-pools\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/fcpm/v2/compute-pools\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'flink_compute_pool_0',\n cloud: 'AWS',\n region: 'us-west-1',\n max_cfu: 5,\n enable_ai: false,\n environment: {id: 'env-00000'},\n network: {id: 'n-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/fcpm/v2/compute-pools\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/fcpm/v2/compute-pools\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"n-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/fcpm/v2/compute-pools/{id}": {
"get": {
"operationId": "getFcpmV2ComputePool",
"summary": "Read a Compute Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/fcpm/v2/compute-pools/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/fcpm/v2/compute-pools/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/fcpm/v2/compute-pools/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/fcpm/v2/compute-pools/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateFcpmV2ComputePool",
"summary": "Update a Compute Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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.ComputePoolUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/fcpm/v2/compute-pools/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"flink_compute_pool_0\",\"cloud\":\"AWS\",\"region\":\"us-west-1\",\"max_cfu\":5,\"enable_ai\":false,\"environment\":{\"id\":\"env-00000\"},\"network\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/fcpm/v2/compute-pools/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/fcpm/v2/compute-pools/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/fcpm/v2/compute-pools/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'flink_compute_pool_0',\n cloud: 'AWS',\n region: 'us-west-1',\n max_cfu: 5,\n enable_ai: false,\n environment: {id: 'env-00000'},\n network: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"flink_compute_pool_0\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-1\\\",\\\"max_cfu\\\":5,\\\"enable_ai\\\":false,\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"network\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteFcpmV2ComputePool",
"summary": "Delete a Compute Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/fcpm/v2/compute-pools/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/fcpm/v2/compute-pools/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/fcpm/v2/compute-pools/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/fcpm/v2/compute-pools/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/fcpm/v2/compute-pools/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/fcpm/v2/regions": {
"get": {
"operationId": "listFcpmV2Regions",
"summary": "List of Regions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/fcpm/v2/regions?cloud=AWS®ion_name=us-east-2' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/fcpm/v2/regions?cloud=AWS®ion_name=us-east-2\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/fcpm/v2/regions?cloud=AWS®ion_name=us-east-2\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/fcpm/v2/regions?cloud=AWS®ion_name=us-east-2\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/fcpm/v2/regions?cloud=AWS®ion_name=us-east-2\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/fcpm/v2/regions?cloud=AWS®ion_name=us-east-2\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/fcpm/v2/regions?cloud=AWS®ion_name=us-east-2\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections": {
"servers": [
{
"url": "https://flink.region.provider.confluent.cloud",
"description": "Flink Compute Pool Endpoint"
}
],
"x-request-access-name": "SQL API v1",
"get": {
"x-request-access-name": "SQL API v1",
"operationId": "listSqlv1Connections",
"summary": "List of Connections",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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": [
"OPENAI",
"AZUREML",
"AZUREOPENAI",
"BEDROCK",
"SAGEMAKER",
"GOOGLEAI",
"VERTEXAI",
"MONGODB",
"PINECONE",
"ELASTIC"
]
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"x-request-access-name": "SQL API v1",
"operationId": "createSqlv1Connection",
"summary": "Create a Connection",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"my-openai-connection\",\"spec\":{\"connection_type\":\"OPENAI\",\"endpoint\":\"https://api.openai.com/v1/chat/completions\",\"auth_data\":{\"kind\":\"PlaintextProvider\",\"data\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\npayload = \"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'my-openai-connection',\n spec: {\n connection_type: 'OPENAI',\n endpoint: 'https://api.openai.com/v1/chat/completions',\n auth_data: {kind: 'PlaintextProvider', data: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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-request-access-name": "SQL API v1",
"get": {
"x-request-access-name": "SQL API v1",
"operationId": "getSqlv1Connection",
"summary": "Read a Connection",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"x-request-access-name": "SQL API v1",
"operationId": "deleteSqlv1Connection",
"summary": "Delete a Connection",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"x-request-access-name": "SQL API v1",
"operationId": "updateSqlv1Connection",
"summary": "Update a Connection",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"]
}
}
}
]
}
}
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"my-openai-connection\",\"spec\":{\"connection_type\":\"OPENAI\",\"endpoint\":\"https://api.openai.com/v1/chat/completions\",\"auth_data\":{\"kind\":\"PlaintextProvider\",\"data\":\"string\"}},\"metadata\":{}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}},\\\"metadata\\\":{}}\");\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}},\\\"metadata\\\":{}}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\npayload = \"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}},\\\"metadata\\\":{}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'my-openai-connection',\n spec: {\n connection_type: 'OPENAI',\n endpoint: 'https://api.openai.com/v1/chat/completions',\n auth_data: {kind: 'PlaintextProvider', data: 'string'}\n },\n metadata: {}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}},\\\"metadata\\\":{}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"name\\\":\\\"my-openai-connection\\\",\\\"spec\\\":{\\\"connection_type\\\":\\\"OPENAI\\\",\\\"endpoint\\\":\\\"https://api.openai.com/v1/chat/completions\\\",\\\"auth_data\\\":{\\\"kind\\\":\\\"PlaintextProvider\\\",\\\"data\\\":\\\"string\\\"}},\\\"metadata\\\":{}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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-request-access-name": "SQL API v1",
"get": {
"x-request-access-name": "SQL API v1",
"operationId": "getSqlv1StatementResult",
"summary": "Read Statement Result",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRead 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": []
}
],
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements": {
"servers": [
{
"url": "https://flink.region.provider.confluent.cloud",
"description": "Flink Compute Pool Endpoint"
}
],
"x-request-access-name": "SQL API v1",
"get": {
"x-request-access-name": "SQL API v1",
"operationId": "listSqlv1Statements",
"summary": "List of Statements",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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."
},
{
"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": []
}
],
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"x-request-access-name": "SQL API v1",
"operationId": "createSqlv1Statement",
"summary": "Create a Statement",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/sql.v1.Statement"
},
{
"type": "object",
"required": ["spec", "name"],
"properties": {
"spec": {
"type": "object",
"required": ["statement", "compute_pool_id"]
}
}
}
]
}
}
}
},
"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",
"compute_pool_id"
]
}
}
}
]
}
}
}
},
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"sql123\",\"organization_id\":\"7c60d51f-b44e-4682-87d6-449835ea4de6\",\"environment_id\":\"string\",\"spec\":{\"statement\":\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\",\"properties\":{\"sql.current-catalog\":\"my_environment\",\"sql.current-database\":\"my_kafka_cluster\"},\"compute_pool_id\":\"fcp-00000\",\"principal\":\"sa-abc123\",\"stopped\":false},\"result\":{\"api_version\":\"sql/v1\",\"kind\":\"StatementResult\",\"metadata\":{\"self\":\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\",\"next\":\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\"},\"results\":{\"data\":[{\"op\":0,\"row\":[\"101\",\"Jay\",[null,\"abc\"],[null,\"456\"],\"1990-01-12 12:00.12\",[[null,\"Alice\"],[\"42\",\"Bob\"]]]}]}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}}}\");\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\npayload = \"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'sql123',\n organization_id: '7c60d51f-b44e-4682-87d6-449835ea4de6',\n environment_id: 'string',\n spec: {\n statement: 'SELECT * FROM TABLE WHERE VALUE1 = VALUE2;',\n properties: {\n 'sql.current-catalog': 'my_environment',\n 'sql.current-database': 'my_kafka_cluster'\n },\n compute_pool_id: 'fcp-00000',\n principal: 'sa-abc123',\n stopped: false\n },\n result: {\n api_version: 'sql/v1',\n kind: 'StatementResult',\n metadata: {\n self: 'https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements',\n next: 'https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb'\n },\n results: {\n data: [\n {\n op: 0,\n row: [\n '101',\n 'Jay',\n [null, 'abc'],\n [null, '456'],\n '1990-01-12 12:00.12',\n [[null, 'Alice'], ['42', 'Bob']]\n ]\n }\n ]\n }\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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-request-access-name": "SQL API v1",
"get": {
"x-request-access-name": "SQL API v1",
"operationId": "getSqlv1Statement",
"summary": "Read a Statement",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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": []
}
],
"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",
"compute_pool_id"
]
}
}
}
]
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"x-request-access-name": "SQL API v1",
"operationId": "deleteSqlv1Statement",
"summary": "Delete a Statement",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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": []
}
],
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"x-request-access-name": "SQL API v1",
"operationId": "updateSqlv1Statement",
"summary": "Update a Statement",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a statement.\nThe request will fail with a 409 Conflict error if the Statement has changed since it was fetched.\nIn 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": []
}
],
"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"]
}
}
}
]
}
}
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"sql123\",\"organization_id\":\"7c60d51f-b44e-4682-87d6-449835ea4de6\",\"environment_id\":\"string\",\"spec\":{\"statement\":\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\",\"properties\":{\"sql.current-catalog\":\"my_environment\",\"sql.current-database\":\"my_kafka_cluster\"},\"compute_pool_id\":\"fcp-00000\",\"principal\":\"sa-abc123\",\"stopped\":false},\"result\":{\"api_version\":\"sql/v1\",\"kind\":\"StatementResult\",\"metadata\":{\"self\":\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\",\"next\":\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\"},\"results\":{\"data\":[{\"op\":0,\"row\":[\"101\",\"Jay\",[null,\"abc\"],[null,\"456\"],\"1990-01-12 12:00.12\",[[null,\"Alice\"],[\"42\",\"Bob\"]]]}]}},\"metadata\":{}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}},\\\"metadata\\\":{}}\");\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}},\\\"metadata\\\":{}}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\npayload = \"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}},\\\"metadata\\\":{}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'sql123',\n organization_id: '7c60d51f-b44e-4682-87d6-449835ea4de6',\n environment_id: 'string',\n spec: {\n statement: 'SELECT * FROM TABLE WHERE VALUE1 = VALUE2;',\n properties: {\n 'sql.current-catalog': 'my_environment',\n 'sql.current-database': 'my_kafka_cluster'\n },\n compute_pool_id: 'fcp-00000',\n principal: 'sa-abc123',\n stopped: false\n },\n result: {\n api_version: 'sql/v1',\n kind: 'StatementResult',\n metadata: {\n self: 'https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements',\n next: 'https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb'\n },\n results: {\n data: [\n {\n op: 0,\n row: [\n '101',\n 'Jay',\n [null, 'abc'],\n [null, '456'],\n '1990-01-12 12:00.12',\n [[null, 'Alice'], ['42', 'Bob']]\n ]\n }\n ]\n }\n },\n metadata: {}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}},\\\"metadata\\\":{}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"name\\\":\\\"sql123\\\",\\\"organization_id\\\":\\\"7c60d51f-b44e-4682-87d6-449835ea4de6\\\",\\\"environment_id\\\":\\\"string\\\",\\\"spec\\\":{\\\"statement\\\":\\\"SELECT * FROM TABLE WHERE VALUE1 = VALUE2;\\\",\\\"properties\\\":{\\\"sql.current-catalog\\\":\\\"my_environment\\\",\\\"sql.current-database\\\":\\\"my_kafka_cluster\\\"},\\\"compute_pool_id\\\":\\\"fcp-00000\\\",\\\"principal\\\":\\\"sa-abc123\\\",\\\"stopped\\\":false},\\\"result\\\":{\\\"api_version\\\":\\\"sql/v1\\\",\\\"kind\\\":\\\"StatementResult\\\",\\\"metadata\\\":{\\\"self\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements\\\",\\\"next\\\":\\\"https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb\\\"},\\\"results\\\":{\\\"data\\\":[{\\\"op\\\":0,\\\"row\\\":[\\\"101\\\",\\\"Jay\\\",[null,\\\"abc\\\"],[null,\\\"456\\\"],\\\"1990-01-12 12:00.12\\\",[[null,\\\"Alice\\\"],[\\\"42\\\",\\\"Bob\\\"]]]}]}},\\\"metadata\\\":{}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"x-request-access-name": "SQL API v1",
"operationId": "patchSqlv1Statement",
"summary": "Patch a Statement",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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": []
}
],
"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",
"compute_pool_id"
]
}
}
}
]
}
}
}
},
"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-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json-patch+json'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\")\n .patch(null)\n .addHeader(\"content-type\", \"application/json-patch+json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\"\n\n\treq, _ := http.NewRequest(\"PATCH\", url, nil)\n\n\treq.Header.Add(\"content-type\", \"application/json-patch+json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = {\n 'content-type': \"application/json-patch+json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\",\n \"headers\": {\n \"content-type\": \"application/json-patch+json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json-patch+json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json-patch+json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/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-request-access-name": "SQL API v1",
"get": {
"x-request-access-name": "SQL API v1",
"operationId": "getSqlv1StatementExceptions",
"summary": "List of Statement Exceptions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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": []
}
],
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"flink.region.provider.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"flink.region.provider.confluent.cloud\",\n \"port\": null,\n \"path\": \"/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/dns-forwarders": {
"get": {
"operationId": "listNetworkingV1DnsForwarders",
"summary": "List of DNS Forwarders",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/dns-forwarders?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-forwarders?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-forwarders?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/dns-forwarders?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-forwarders?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-forwarders?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-forwarders?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1DnsForwarder",
"summary": "Create a DNS Forwarder",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/dns-forwarders \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-dnsf-1\",\"domains\":[\"example.com\",\"domainname.com\"],\"config\":{\"kind\":\"ForwardViaIp\",\"dns_server_ips\":[\"10.200.0.0\",\"10.200.0.1\"]},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"gateway\":{\"id\":\"gw-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-forwarders\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-forwarders\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/dns-forwarders\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-forwarders\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-dnsf-1',\n domains: ['example.com', 'domainname.com'],\n config: {kind: 'ForwardViaIp', dns_server_ips: ['10.200.0.0', '10.200.0.1']},\n environment: {id: 'env-00000', environment: 'string'},\n gateway: {id: 'gw-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-forwarders\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-forwarders\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/dns-forwarders/{id}": {
"get": {
"operationId": "getNetworkingV1DnsForwarder",
"summary": "Read a DNS Forwarder",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/dns-forwarders/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-forwarders/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/dns-forwarders/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-forwarders/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1DnsForwarder",
"summary": "Update a DNS Forwarder",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a DNS forwarder.\n\n",
"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.DnsForwarderUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/dns-forwarders/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-dnsf-1\",\"domains\":[\"example.com\",\"domainname.com\"],\"config\":{\"kind\":\"ForwardViaIp\",\"dns_server_ips\":[\"10.200.0.0\",\"10.200.0.1\"]},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"gateway\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-forwarders/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/dns-forwarders/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-forwarders/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-dnsf-1',\n domains: ['example.com', 'domainname.com'],\n config: {kind: 'ForwardViaIp', dns_server_ips: ['10.200.0.0', '10.200.0.1']},\n environment: {id: 'env-00000', environment: 'string'},\n gateway: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsf-1\\\",\\\"domains\\\":[\\\"example.com\\\",\\\"domainname.com\\\"],\\\"config\\\":{\\\"kind\\\":\\\"ForwardViaIp\\\",\\\"dns_server_ips\\\":[\\\"10.200.0.0\\\",\\\"10.200.0.1\\\"]},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1DnsForwarder",
"summary": "Delete a DNS Forwarder",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/dns-forwarders/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-forwarders/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/dns-forwarders/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-forwarders/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-forwarders/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/access-points": {
"get": {
"operationId": "listNetworkingV1AccessPoints",
"summary": "List of Access Points",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/access-points?spec.display_name=prod-ap-egress-use1,prod-ap-egress-usw2&environment=env-00000&spec.gateway=gw-00000,gw-00001&id=ap-1,ap-2' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/access-points?spec.display_name=prod-ap-egress-use1,prod-ap-egress-usw2&environment=env-00000&spec.gateway=gw-00000,gw-00001&id=ap-1,ap-2\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/access-points?spec.display_name=prod-ap-egress-use1,prod-ap-egress-usw2&environment=env-00000&spec.gateway=gw-00000,gw-00001&id=ap-1,ap-2\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/access-points?spec.display_name=prod-ap-egress-use1,prod-ap-egress-usw2&environment=env-00000&spec.gateway=gw-00000,gw-00001&id=ap-1,ap-2\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/access-points?spec.display_name=prod-ap-egress-use1,prod-ap-egress-usw2&environment=env-00000&spec.gateway=gw-00000,gw-00001&id=ap-1,ap-2\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/access-points?spec.display_name=prod-ap-egress-use1,prod-ap-egress-usw2&environment=env-00000&spec.gateway=gw-00000,gw-00001&id=ap-1,ap-2\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/access-points?spec.display_name=prod-ap-egress-use1,prod-ap-egress-usw2&environment=env-00000&spec.gateway=gw-00000,gw-00001&id=ap-1,ap-2\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1AccessPoint",
"summary": "Create an Access Point",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/access-points \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-ap-egress-usw2\",\"config\":{\"kind\":\"AwsEgressPrivateLinkEndpoint\",\"vpc_endpoint_service_name\":\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\",\"enable_high_availability\":false,\"target_system\":\"S3\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"gateway\":{\"id\":\"gw-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/access-points\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/access-points\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/access-points\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/access-points\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-ap-egress-usw2',\n config: {\n kind: 'AwsEgressPrivateLinkEndpoint',\n vpc_endpoint_service_name: 'com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000',\n enable_high_availability: false,\n target_system: 'S3'\n },\n environment: {id: 'env-00000', environment: 'string'},\n gateway: {id: 'gw-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/access-points\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/access-points\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/access-points/{id}": {
"get": {
"operationId": "getNetworkingV1AccessPoint",
"summary": "Read an Access Point",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/access-points/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/access-points/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/access-points/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/access-points/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/access-points/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/access-points/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/access-points/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1AccessPoint",
"summary": "Update an Access Point",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update an access point.\n\n",
"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.AccessPointUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/access-points/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-ap-egress-usw2\",\"config\":{\"kind\":\"AwsEgressPrivateLinkEndpoint\",\"vpc_endpoint_service_name\":\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\",\"enable_high_availability\":false,\"target_system\":\"S3\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"gateway\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/access-points/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/access-points/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/access-points/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/access-points/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-ap-egress-usw2',\n config: {\n kind: 'AwsEgressPrivateLinkEndpoint',\n vpc_endpoint_service_name: 'com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000',\n enable_high_availability: false,\n target_system: 'S3'\n },\n environment: {id: 'env-00000', environment: 'string'},\n gateway: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/access-points/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/access-points/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-ap-egress-usw2\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkEndpoint\\\",\\\"vpc_endpoint_service_name\\\":\\\"com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000\\\",\\\"enable_high_availability\\\":false,\\\"target_system\\\":\\\"S3\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1AccessPoint",
"summary": "Delete an Access Point",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/access-points/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/access-points/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/access-points/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/access-points/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/access-points/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/access-points/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/access-points/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/dns-records": {
"get": {
"operationId": "listNetworkingV1DnsRecords",
"summary": "List of DNS Records",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/dns-records?spec.display_name=prod-dnsrec-1,prod-dnsrec-2&spec.domain=example.com,example2.com&environment=env-00000&spec.gateway=gw-00000,gw-00001&resource=ap-11111,ap-22222' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-records?spec.display_name=prod-dnsrec-1,prod-dnsrec-2&spec.domain=example.com,example2.com&environment=env-00000&spec.gateway=gw-00000,gw-00001&resource=ap-11111,ap-22222\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-records?spec.display_name=prod-dnsrec-1,prod-dnsrec-2&spec.domain=example.com,example2.com&environment=env-00000&spec.gateway=gw-00000,gw-00001&resource=ap-11111,ap-22222\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/dns-records?spec.display_name=prod-dnsrec-1,prod-dnsrec-2&spec.domain=example.com,example2.com&environment=env-00000&spec.gateway=gw-00000,gw-00001&resource=ap-11111,ap-22222\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-records?spec.display_name=prod-dnsrec-1,prod-dnsrec-2&spec.domain=example.com,example2.com&environment=env-00000&spec.gateway=gw-00000,gw-00001&resource=ap-11111,ap-22222\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-records?spec.display_name=prod-dnsrec-1,prod-dnsrec-2&spec.domain=example.com,example2.com&environment=env-00000&spec.gateway=gw-00000,gw-00001&resource=ap-11111,ap-22222\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-records?spec.display_name=prod-dnsrec-1,prod-dnsrec-2&spec.domain=example.com,example2.com&environment=env-00000&spec.gateway=gw-00000,gw-00001&resource=ap-11111,ap-22222\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1DnsRecord",
"summary": "Create a DNS Record",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/dns-records \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-dnsrec-1\",\"domain\":\"example.com\",\"config\":{\"kind\":\"PrivateLinkAccessPoint\",\"resource_id\":\"ap-12345\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"gateway\":{\"id\":\"gw-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-records\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-records\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/dns-records\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-records\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-dnsrec-1',\n domain: 'example.com',\n config: {kind: 'PrivateLinkAccessPoint', resource_id: 'ap-12345'},\n environment: {id: 'env-00000', environment: 'string'},\n gateway: {id: 'gw-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-records\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-records\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"gw-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/dns-records/{id}": {
"get": {
"operationId": "getNetworkingV1DnsRecord",
"summary": "Read a DNS Record",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/dns-records/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-records/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-records/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/dns-records/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-records/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-records/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-records/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1DnsRecord",
"summary": "Update a DNS Record",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a DNS record.\n\n",
"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.DnsRecordUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/dns-records/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-dnsrec-1\",\"domain\":\"example.com\",\"config\":{\"kind\":\"PrivateLinkAccessPoint\",\"resource_id\":\"ap-12345\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"},\"gateway\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-records/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-records/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/dns-records/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-records/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-dnsrec-1',\n domain: 'example.com',\n config: {kind: 'PrivateLinkAccessPoint', resource_id: 'ap-12345'},\n environment: {id: 'env-00000', environment: 'string'},\n gateway: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-records/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-records/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-dnsrec-1\\\",\\\"domain\\\":\\\"example.com\\\",\\\"config\\\":{\\\"kind\\\":\\\"PrivateLinkAccessPoint\\\",\\\"resource_id\\\":\\\"ap-12345\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"},\\\"gateway\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1DnsRecord",
"summary": "Delete a DNS Record",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/dns-records/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/dns-records/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/dns-records/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/dns-records/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/dns-records/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/dns-records/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/dns-records/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/certificate-authorities": {
"get": {
"operationId": "listIamV2CertificateAuthorities",
"summary": "List of Certificate Authorities",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url https://api.confluent.cloud/iam/v2/certificate-authorities \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/certificate-authorities\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/iam.v2.CreateCertRequest"
}
}
}
},
"operationId": "createIamV2CertificateAuthority",
"summary": "Create a Certificate Authority",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/iam/v2/certificate-authorities \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"My Certificate Authority\",\"description\":\"Sample description text\",\"certificate_chain\":\"-----BEGIN CERTIFICATE-----\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n-----END CERTIFICATE-----\",\"certificate_chain_filename\":\"certificate.pem\",\"crl_url\":\"http://example.com\",\"crl_chain\":\"-----BEGIN X509 CRL-----\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\n-----END X509 CRL-----\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/certificate-authorities\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'My Certificate Authority',\n description: 'Sample description text',\n certificate_chain: '-----BEGIN CERTIFICATE-----\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n-----END CERTIFICATE-----',\n certificate_chain_filename: 'certificate.pem',\n crl_url: 'http://example.com',\n crl_chain: '-----BEGIN X509 CRL-----\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\n-----END X509 CRL-----'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/certificate-authorities/{id}": {
"get": {
"operationId": "getIamV2CertificateAuthority",
"summary": "Read a Certificate Authority",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/certificate-authorities/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/certificate-authorities/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/iam.v2.UpdateCertRequest"
}
}
}
},
"operationId": "updateIamV2CertificateAuthority",
"summary": "Update a Certificate Authority",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a certificate authority.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://api.confluent.cloud/iam/v2/certificate-authorities/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"My Certificate Authority\",\"description\":\"Sample description text\",\"certificate_chain\":\"-----BEGIN CERTIFICATE-----\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n-----END CERTIFICATE-----\",\"certificate_chain_filename\":\"certificate.pem\",\"crl_url\":\"http://example.com\",\"crl_chain\":\"-----BEGIN X509 CRL-----\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\n-----END X509 CRL-----\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/iam/v2/certificate-authorities/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'My Certificate Authority',\n description: 'Sample description text',\n certificate_chain: '-----BEGIN CERTIFICATE-----\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n-----END CERTIFICATE-----',\n certificate_chain_filename: 'certificate.pem',\n crl_url: 'http://example.com',\n crl_chain: '-----BEGIN X509 CRL-----\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\n-----END X509 CRL-----'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"My Certificate Authority\\\",\\\"description\\\":\\\"Sample description text\\\",\\\"certificate_chain\\\":\\\"-----BEGIN CERTIFICATE-----\\\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\\\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\\\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\\\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\\\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\\\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\\\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\\\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\\\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\\\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\\\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\\\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\\\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\\\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\\\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\\\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\\\n-----END CERTIFICATE-----\\\",\\\"certificate_chain_filename\\\":\\\"certificate.pem\\\",\\\"crl_url\\\":\\\"http://example.com\\\",\\\"crl_chain\\\":\\\"-----BEGIN X509 CRL-----\\\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\\\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\\\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\\\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\\\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\\\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\\\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\\\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\\\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\\\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\\\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\\\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\\\n-----END X509 CRL-----\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2CertificateAuthority",
"summary": "Delete a Certificate Authority",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/certificate-authorities/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/certificate-authorities/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools": {
"get": {
"operationId": "listIamV2CertificateIdentityPools",
"summary": "List of Certificate Identity Pools",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createIamV2CertificateIdentityPool",
"summary": "Create a Certificate Identity Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools?assigned_resource_owner=u-a83k9b' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"My Identity Pool\",\"description\":\"Prod Access to Kafka clusters to Release Engineering\",\"external_identifier\":\"UID\",\"filter\":\"C=='\\''Canada'\\'' && O=='\\''Confluent'\\''\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools?assigned_resource_owner=u-a83k9b\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools?assigned_resource_owner=u-a83k9b\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools?assigned_resource_owner=u-a83k9b\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools?assigned_resource_owner=u-a83k9b\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'My Identity Pool',\n description: 'Prod Access to Kafka clusters to Release Engineering',\n external_identifier: 'UID',\n filter: 'C==\\'Canada\\' && O==\\'Confluent\\''\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools?assigned_resource_owner=u-a83k9b\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools?assigned_resource_owner=u-a83k9b\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}": {
"get": {
"operationId": "getIamV2CertificateIdentityPool",
"summary": "Read a Certificate Identity Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"put": {
"operationId": "updateIamV2CertificateIdentityPool",
"summary": "Update a Certificate Identity Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a certificate identity pool.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PUT \\\n --url 'https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"My Identity Pool\",\"description\":\"Prod Access to Kafka clusters to Release Engineering\",\"external_identifier\":\"UID\",\"filter\":\"C=='\\''Canada'\\'' && O=='\\''Confluent'\\''\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\")\n .put(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PUT\", \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 'My Identity Pool',\n description: 'Prod Access to Kafka clusters to Release Engineering',\n external_identifier: 'UID',\n filter: 'C==\\'Canada\\' && O==\\'Confluent\\''\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"My Identity Pool\\\",\\\"description\\\":\\\"Prod Access to Kafka clusters to Release Engineering\\\",\\\"external_identifier\\\":\\\"UID\\\",\\\"filter\\\":\\\"C=='Canada' && O=='Confluent'\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteIamV2CertificateIdentityPool",
"summary": "Delete a Certificate Identity Pool",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/pim/v1/integrations": {
"get": {
"operationId": "listPimV1Integrations",
"summary": "List of Integrations",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve a sorted, filtered, paginated list of all integrations.\n\nIf no `provider` filter is specified, returns provider integrations from all clouds.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/pim/v1/integrations?provider=AWS&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/pim/v1/integrations?provider=AWS&environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/pim/v1/integrations?provider=AWS&environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/pim/v1/integrations?provider=AWS&environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/pim/v1/integrations?provider=AWS&environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/pim/v1/integrations?provider=AWS&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/pim/v1/integrations?provider=AWS&environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createPimV1Integration",
"summary": "Create an Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/pim/v1/integrations \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"display_name\":\"s3_provider_integration\",\"provider\":\"AWS\",\"config\":{\"customer_iam_role_arn\":\"arn:aws:iam::000000000000:role/my-test-aws-role\",\"kind\":\"AwsIntegrationConfig\"},\"environment\":{\"id\":\"env-00000\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"display_name\\\":\\\"s3_provider_integration\\\",\\\"provider\\\":\\\"AWS\\\",\\\"config\\\":{\\\"customer_iam_role_arn\\\":\\\"arn:aws:iam::000000000000:role/my-test-aws-role\\\",\\\"kind\\\":\\\"AwsIntegrationConfig\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/pim/v1/integrations\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/pim/v1/integrations\"\n\n\tpayload := strings.NewReader(\"{\\\"display_name\\\":\\\"s3_provider_integration\\\",\\\"provider\\\":\\\"AWS\\\",\\\"config\\\":{\\\"customer_iam_role_arn\\\":\\\"arn:aws:iam::000000000000:role/my-test-aws-role\\\",\\\"kind\\\":\\\"AwsIntegrationConfig\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"display_name\\\":\\\"s3_provider_integration\\\",\\\"provider\\\":\\\"AWS\\\",\\\"config\\\":{\\\"customer_iam_role_arn\\\":\\\"arn:aws:iam::000000000000:role/my-test-aws-role\\\",\\\"kind\\\":\\\"AwsIntegrationConfig\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/pim/v1/integrations\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/pim/v1/integrations\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n display_name: 's3_provider_integration',\n provider: 'AWS',\n config: {\n customer_iam_role_arn: 'arn:aws:iam::000000000000:role/my-test-aws-role',\n kind: 'AwsIntegrationConfig'\n },\n environment: {id: 'env-00000'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/pim/v1/integrations\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"display_name\\\":\\\"s3_provider_integration\\\",\\\"provider\\\":\\\"AWS\\\",\\\"config\\\":{\\\"customer_iam_role_arn\\\":\\\"arn:aws:iam::000000000000:role/my-test-aws-role\\\",\\\"kind\\\":\\\"AwsIntegrationConfig\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/pim/v1/integrations\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"display_name\\\":\\\"s3_provider_integration\\\",\\\"provider\\\":\\\"AWS\\\",\\\"config\\\":{\\\"customer_iam_role_arn\\\":\\\"arn:aws:iam::000000000000:role/my-test-aws-role\\\",\\\"kind\\\":\\\"AwsIntegrationConfig\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/pim/v1/integrations/{id}": {
"get": {
"operationId": "getPimV1Integration",
"summary": "Read an Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/pim/v1/integrations/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/pim/v1/integrations/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/pim/v1/integrations/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/pim/v1/integrations/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/pim/v1/integrations/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/pim/v1/integrations/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/pim/v1/integrations/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deletePimV1Integration",
"summary": "Delete an Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to delete an integration.\n\nThis request fails if existing workloads are using this CSP integration.\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/pim/v1/integrations/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/pim/v1/integrations/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/pim/v1/integrations/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/pim/v1/integrations/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/pim/v1/integrations/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/pim/v1/integrations/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/pim/v1/integrations/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/artifact/v1/flink-artifacts": {
"get": {
"operationId": "listArtifactV1FlinkArtifacts",
"summary": "List of Flink Artifacts",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1&environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1&environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1&environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1&environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1&environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"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"
]
}
}
}
},
"operationId": "createArtifactV1FlinkArtifact",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url 'https://api.confluent.cloud/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"cloud\":\"AWS\",\"region\":\"us-east-1\",\"environment\":\"env-00000\",\"display_name\":\"string\",\"class\":\"io.confluent.example.SumScalarFunction\",\"content_format\":\"JAR\",\"description\":\"string\",\"documentation_link\":\"string\",\"runtime_language\":\"JAVA\",\"upload_source\":{\"location\":\"PRESIGNED_URL_LOCATION\",\"upload_id\":\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1\"\n\n\tpayload := strings.NewReader(\"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n cloud: 'AWS',\n region: 'us-east-1',\n environment: 'env-00000',\n display_name: 'string',\n class: 'io.confluent.example.SumScalarFunction',\n content_format: 'JAR',\n description: 'string',\n documentation_link: 'string',\n runtime_language: 'JAVA',\n upload_source: {\n location: 'PRESIGNED_URL_LOCATION',\n upload_id: 'e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66'\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/artifact/v1/flink-artifacts?cloud=AWS®ion=us-east-1\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/artifact/v1/flink-artifacts/{id}": {
"get": {
"operationId": "getArtifactV1FlinkArtifact",
"summary": "Read a Flink Artifact",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateArtifactV1FlinkArtifact",
"summary": "Update a Flink Artifact",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a flink artifact.\n\n",
"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.FlinkArtifactUpdate"
}
}
}
},
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"cloud\":\"AWS\",\"region\":\"us-east-1\",\"environment\":\"env-00000\",\"display_name\":\"string\",\"class\":\"io.confluent.example.SumScalarFunction\",\"content_format\":\"JAR\",\"description\":\"string\",\"documentation_link\":\"string\",\"runtime_language\":\"JAVA\",\"versions\":[{\"version\":\"cfa-ver-001\",\"release_notes\":\"string\",\"is_beta\":true,\"artifact_id\":{},\"upload_source\":{\"location\":\"PRESIGNED_URL_LOCATION\",\"upload_id\":\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\"}}]}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"versions\\\":[{\\\"version\\\":\\\"cfa-ver-001\\\",\\\"release_notes\\\":\\\"string\\\",\\\"is_beta\\\":true,\\\"artifact_id\\\":{},\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\"\n\n\tpayload := strings.NewReader(\"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"versions\\\":[{\\\"version\\\":\\\"cfa-ver-001\\\",\\\"release_notes\\\":\\\"string\\\",\\\"is_beta\\\":true,\\\"artifact_id\\\":{},\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}]}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"versions\\\":[{\\\"version\\\":\\\"cfa-ver-001\\\",\\\"release_notes\\\":\\\"string\\\",\\\"is_beta\\\":true,\\\"artifact_id\\\":{},\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n cloud: 'AWS',\n region: 'us-east-1',\n environment: 'env-00000',\n display_name: 'string',\n class: 'io.confluent.example.SumScalarFunction',\n content_format: 'JAR',\n description: 'string',\n documentation_link: 'string',\n runtime_language: 'JAVA',\n versions: [\n {\n version: 'cfa-ver-001',\n release_notes: 'string',\n is_beta: true,\n artifact_id: {},\n upload_source: {\n location: 'PRESIGNED_URL_LOCATION',\n upload_id: 'e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66'\n }\n }\n ]\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"versions\\\":[{\\\"version\\\":\\\"cfa-ver-001\\\",\\\"release_notes\\\":\\\"string\\\",\\\"is_beta\\\":true,\\\"artifact_id\\\":{},\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}]}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\",\\\"display_name\\\":\\\"string\\\",\\\"class\\\":\\\"io.confluent.example.SumScalarFunction\\\",\\\"content_format\\\":\\\"JAR\\\",\\\"description\\\":\\\"string\\\",\\\"documentation_link\\\":\\\"string\\\",\\\"runtime_language\\\":\\\"JAVA\\\",\\\"versions\\\":[{\\\"version\\\":\\\"cfa-ver-001\\\",\\\"release_notes\\\":\\\"string\\\",\\\"is_beta\\\":true,\\\"artifact_id\\\":{},\\\"upload_source\\\":{\\\"location\\\":\\\"PRESIGNED_URL_LOCATION\\\",\\\"upload_id\\\":\\\"e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66\\\"}}]}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteArtifactV1FlinkArtifact",
"summary": "Delete a Flink Artifact",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/artifact/v1/flink-artifacts/{id}?cloud=AWS®ion=us-east-1&environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/artifact/v1/presigned-upload-url": {
"post": {
"summary": "Request a presigned upload URL for a new Flink Artifact.",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRequest 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-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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/artifact/v1/presigned-upload-url \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"content_format\":\"JAR\",\"cloud\":\"AWS\",\"region\":\"us-east-1\",\"environment\":\"env-00000\"}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"content_format\\\":\\\"JAR\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/artifact/v1/presigned-upload-url\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/artifact/v1/presigned-upload-url\"\n\n\tpayload := strings.NewReader(\"{\\\"content_format\\\":\\\"JAR\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"content_format\\\":\\\"JAR\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/artifact/v1/presigned-upload-url\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/artifact/v1/presigned-upload-url\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n content_format: 'JAR',\n cloud: 'AWS',\n region: 'us-east-1',\n environment: 'env-00000'\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/artifact/v1/presigned-upload-url\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"content_format\\\":\\\"JAR\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\"}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/artifact/v1/presigned-upload-url\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"content_format\\\":\\\"JAR\\\",\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-east-1\\\",\\\"environment\\\":\\\"env-00000\\\"}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/gateways": {
"get": {
"operationId": "listNetworkingV1Gateways",
"summary": "List of Gateways",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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": "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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/gateways?environment=env-00000&gateway_type=AwsEgressPrivateLink,AzureEgressPrivateLink&id=gw-1,gw-2' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/gateways?environment=env-00000&gateway_type=AwsEgressPrivateLink,AzureEgressPrivateLink&id=gw-1,gw-2\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/gateways?environment=env-00000&gateway_type=AwsEgressPrivateLink,AzureEgressPrivateLink&id=gw-1,gw-2\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/gateways?environment=env-00000&gateway_type=AwsEgressPrivateLink,AzureEgressPrivateLink&id=gw-1,gw-2\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/gateways?environment=env-00000&gateway_type=AwsEgressPrivateLink,AzureEgressPrivateLink&id=gw-1,gw-2\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/gateways?environment=env-00000&gateway_type=AwsEgressPrivateLink,AzureEgressPrivateLink&id=gw-1,gw-2\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/gateways?environment=env-00000&gateway_type=AwsEgressPrivateLink,AzureEgressPrivateLink&id=gw-1,gw-2\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createNetworkingV1Gateway",
"summary": "Create a Gateway",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/networking/v1/gateways \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-gateway\",\"config\":{\"kind\":\"AwsEgressPrivateLinkGatewaySpec\",\"region\":\"string\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/gateways\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/gateways\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/networking/v1/gateways\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/gateways\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-gateway',\n config: {kind: 'AwsEgressPrivateLinkGatewaySpec', region: 'string'},\n environment: {id: 'env-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/gateways\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/gateways\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/networking/v1/gateways/{id}": {
"get": {
"operationId": "getNetworkingV1Gateway",
"summary": "Read a Gateway",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/networking/v1/gateways/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/gateways/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/gateways/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/networking/v1/gateways/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/gateways/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/gateways/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/gateways/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateNetworkingV1Gateway",
"summary": "Update a Gateway",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a gateway.\n\n",
"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.GatewayUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/networking/v1/gateways/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"prod-gateway\",\"config\":{\"kind\":\"AwsEgressPrivateLinkGatewaySpec\",\"region\":\"string\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/gateways/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/gateways/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/networking/v1/gateways/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/gateways/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'prod-gateway',\n config: {kind: 'AwsEgressPrivateLinkGatewaySpec', region: 'string'},\n environment: {id: 'env-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/gateways/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/gateways/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"prod-gateway\\\",\\\"config\\\":{\\\"kind\\\":\\\"AwsEgressPrivateLinkGatewaySpec\\\",\\\"region\\\":\\\"string\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteNetworkingV1Gateway",
"summary": "Delete a Gateway",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/networking/v1/gateways/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/networking/v1/gateways/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/networking/v1/gateways/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/networking/v1/gateways/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/networking/v1/gateways/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/networking/v1/gateways/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/networking/v1/gateways/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/ccl/v1/custom-code-loggings": {
"x-request-access-name": "Custom Code Logging API EA",
"get": {
"x-request-access-name": "Custom Code Logging API EA",
"operationId": "listCclV1CustomCodeLoggings",
"summary": "List of Custom Code Loggings",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/ccl/v1/custom-code-loggings?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ccl/v1/custom-code-loggings?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/ccl/v1/custom-code-loggings?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ccl/v1/custom-code-loggings?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ccl/v1/custom-code-loggings?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"x-request-access-name": "Custom Code Logging API EA",
"operationId": "createCclV1CustomCodeLogging",
"summary": "Create a Custom Code Logging",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/ccl/v1/custom-code-loggings \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"cloud\":\"AWS\",\"region\":\"us-west-2\",\"destination_settings\":{\"kind\":\"Kafka\",\"cluster_id\":\"lkc-123\",\"topic\":\"topic-123\",\"log_level\":\"INFO\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ccl/v1/custom-code-loggings\"\n\n\tpayload := strings.NewReader(\"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/ccl/v1/custom-code-loggings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ccl/v1/custom-code-loggings\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n cloud: 'AWS',\n region: 'us-west-2',\n destination_settings: {kind: 'Kafka', cluster_id: 'lkc-123', topic: 'topic-123', log_level: 'INFO'},\n environment: {id: 'env-00000', environment: 'string'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ccl/v1/custom-code-loggings\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/ccl/v1/custom-code-loggings/{id}": {
"x-request-access-name": "Custom Code Logging API EA",
"get": {
"x-request-access-name": "Custom Code Logging API EA",
"operationId": "getCclV1CustomCodeLogging",
"summary": "Read a Custom Code Logging",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ccl/v1/custom-code-loggings/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/ccl/v1/custom-code-loggings/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ccl/v1/custom-code-loggings/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"x-request-access-name": "Custom Code Logging API EA",
"operationId": "updateCclV1CustomCodeLogging",
"summary": "Update a Custom Code Logging",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nMake a request to update a custom code logging.\n\n",
"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.CustomCodeLoggingUpdate"
},
{
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"cloud\":\"AWS\",\"region\":\"us-west-2\",\"destination_settings\":{\"kind\":\"Kafka\",\"cluster_id\":\"lkc-123\",\"topic\":\"topic-123\",\"log_level\":\"INFO\"},\"environment\":{\"id\":\"env-00000\",\"environment\":\"string\"}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ccl/v1/custom-code-loggings/{id}?environment=env-00000\"\n\n\tpayload := strings.NewReader(\"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/ccl/v1/custom-code-loggings/{id}?environment=env-00000\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ccl/v1/custom-code-loggings/{id}?environment=env-00000\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n cloud: 'AWS',\n region: 'us-west-2',\n destination_settings: {kind: 'Kafka', cluster_id: 'lkc-123', topic: 'topic-123', log_level: 'INFO'},\n environment: {id: 'env-00000', environment: 'string'}\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"cloud\\\":\\\"AWS\\\",\\\"region\\\":\\\"us-west-2\\\",\\\"destination_settings\\\":{\\\"kind\\\":\\\"Kafka\\\",\\\"cluster_id\\\":\\\"lkc-123\\\",\\\"topic\\\":\\\"topic-123\\\",\\\"log_level\\\":\\\"INFO\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\",\\\"environment\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"x-request-access-name": "Custom Code Logging API EA",
"operationId": "deleteCclV1CustomCodeLogging",
"summary": "Delete a Custom Code Logging",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/ccl/v1/custom-code-loggings/{id}?environment=env-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/ccl/v1/custom-code-loggings/{id}?environment=env-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/ccl/v1/custom-code-loggings/{id}?environment=env-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id}?environment=env-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/tableflow/v1/regions": {
"get": {
"operationId": "listTableflowV1Regions",
"summary": "List of Regions",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/tableflow/v1/regions?cloud=AWS' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/regions?cloud=AWS\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/regions?cloud=AWS\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/tableflow/v1/regions?cloud=AWS\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/regions?cloud=AWS\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/regions?cloud=AWS\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/regions?cloud=AWS\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/tableflow/v1/tableflow-topics": {
"get": {
"operationId": "listTableflowV1TableflowTopics",
"summary": "List of Tableflow Topics",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve a sorted, filtered, paginated list of all tableflow topics.",
"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": ["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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/tableflow/v1/tableflow-topics?environment=env-00000&spec.kafka_cluster=lkc-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics?environment=env-00000&spec.kafka_cluster=lkc-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/tableflow-topics?environment=env-00000&spec.kafka_cluster=lkc-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/tableflow/v1/tableflow-topics?environment=env-00000&spec.kafka_cluster=lkc-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/tableflow-topics?environment=env-00000&spec.kafka_cluster=lkc-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/tableflow-topics?environment=env-00000&spec.kafka_cluster=lkc-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics?environment=env-00000&spec.kafka_cluster=lkc-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createTableflowV1TableflowTopic",
"summary": "Create a Tableflow Topic",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"],
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/tableflow/v1/tableflow-topics \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"topic_1\",\"suspended\":false,\"config\":{\"retention_ms\":\"7776000000\",\"record_failure_strategy\":\"SUSPEND\"},\"storage\":{\"kind\":\"ByobAws\",\"bucket_name\":\"bucket_1\",\"provider_integration_id\":\"cspi-stgce89r7\"},\"table_formats\":[\"DELTA\"],\"environment\":{\"id\":\"env-00000\"},\"kafka_cluster\":{\"id\":\"lkc-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/tableflow-topics\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/tableflow/v1/tableflow-topics\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/tableflow-topics\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'topic_1',\n suspended: false,\n config: {retention_ms: '7776000000', record_failure_strategy: 'SUSPEND'},\n storage: {\n kind: 'ByobAws',\n bucket_name: 'bucket_1',\n provider_integration_id: 'cspi-stgce89r7'\n },\n table_formats: ['DELTA'],\n environment: {id: 'env-00000'},\n kafka_cluster: {id: 'lkc-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/tableflow-topics\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/tableflow/v1/tableflow-topics/{display_name}": {
"get": {
"operationId": "getTableflowV1TableflowTopic",
"summary": "Read a Tableflow Topic",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"],
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"operationId": "updateTableflowV1TableflowTopic",
"summary": "Update a Tableflow Topic",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a tableflow topic.\n\n",
"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.TableflowTopicUpdate"
},
{
"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"],
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"topic_1\",\"suspended\":false,\"config\":{\"retention_ms\":\"7776000000\",\"record_failure_strategy\":\"SUSPEND\"},\"storage\":{\"kind\":\"ByobAws\",\"bucket_name\":\"bucket_1\",\"provider_integration_id\":\"cspi-stgce89r7\"},\"table_formats\":[\"DELTA\"],\"environment\":{\"id\":\"env-00000\"},\"kafka_cluster\":{\"id\":\"string\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/tableflow-topics/{display_name}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/tableflow/v1/tableflow-topics/{display_name}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/tableflow-topics/{display_name}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'topic_1',\n suspended: false,\n config: {retention_ms: '7776000000', record_failure_strategy: 'SUSPEND'},\n storage: {\n kind: 'ByobAws',\n bucket_name: 'bucket_1',\n provider_integration_id: 'cspi-stgce89r7'\n },\n table_formats: ['DELTA'],\n environment: {id: 'env-00000'},\n kafka_cluster: {id: 'string', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"topic_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"retention_ms\\\":\\\"7776000000\\\",\\\"record_failure_strategy\\\":\\\"SUSPEND\\\"},\\\"storage\\\":{\\\"kind\\\":\\\"ByobAws\\\",\\\"bucket_name\\\":\\\"bucket_1\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"table_formats\\\":[\\\"DELTA\\\"],\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"string\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteTableflowV1TableflowTopic",
"summary": "Delete a Tableflow Topic",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/tableflow-topics/{display_name}?environment=env-00000&spec.kafka_cluster=lkc-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/tableflow/v1/catalog-integrations": {
"get": {
"operationId": "listTableflowV1CatalogIntegrations",
"summary": "List of Catalog Integrations",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRetrieve 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/tableflow/v1/catalog-integrations?environment=env-00000&spec.kafka_cluster=lkc-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations?environment=env-00000&spec.kafka_cluster=lkc-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/catalog-integrations?environment=env-00000&spec.kafka_cluster=lkc-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/tableflow/v1/catalog-integrations?environment=env-00000&spec.kafka_cluster=lkc-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/catalog-integrations?environment=env-00000&spec.kafka_cluster=lkc-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/catalog-integrations?environment=env-00000&spec.kafka_cluster=lkc-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations?environment=env-00000&spec.kafka_cluster=lkc-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"post": {
"operationId": "createTableflowV1CatalogIntegration",
"summary": "Create a Catalog Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request POST \\\n --url https://api.confluent.cloud/tableflow/v1/catalog-integrations \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"catalog_integration_1\",\"suspended\":false,\"config\":{\"kind\":\"AwsGlue\",\"provider_integration_id\":\"cspi-stgce89r7\"},\"environment\":{\"id\":\"env-00000\"},\"kafka_cluster\":{\"id\":\"lkc-00000\",\"environment\":\"string\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/catalog-integrations\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"POST\", \"/tableflow/v1/catalog-integrations\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/catalog-integrations\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'catalog_integration_1',\n suspended: false,\n config: {kind: 'AwsGlue', provider_integration_id: 'cspi-stgce89r7'},\n environment: {id: 'env-00000'},\n kafka_cluster: {id: 'lkc-00000', environment: 'string'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/catalog-integrations\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\",\\\"provider_integration_id\\\":\\\"cspi-stgce89r7\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\",\\\"environment\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
}
},
"/tableflow/v1/catalog-integrations/{id}": {
"get": {
"operationId": "getTableflowV1CatalogIntegration",
"summary": "Read a Catalog Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request GET \\\n --url 'https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\")\n .get()\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"GET\", \"/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"GET\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
},
"patch": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tableflow.v1.CatalogIntegrationUpdateRequest"
}
}
}
},
"operationId": "updateTableflowV1CatalogIntegration",
"summary": "Update a Catalog Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake a request to update a catalog integration.\n\n",
"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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request PATCH \\\n --url 'https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH' \\\n --header 'content-type: application/json' \\\n --data '{\"spec\":{\"display_name\":\"catalog_integration_1\",\"suspended\":false,\"config\":{\"kind\":\"AwsGlue\"},\"environment\":{\"id\":\"env-00000\"},\"kafka_cluster\":{\"id\":\"lkc-00000\"}}}'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\"}}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/catalog-integrations/{id}\"\n\n\tpayload := strings.NewReader(\"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\"}}}\")\n\n\treq, _ := http.NewRequest(\"PATCH\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\npayload = \"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\"}}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"Basic REPLACE_BASIC_AUTH\"\n }\n\nconn.request(\"PATCH\", \"/tableflow/v1/catalog-integrations/{id}\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/catalog-integrations/{id}\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n spec: {\n display_name: 'catalog_integration_1',\n suspended: false,\n config: {kind: 'AwsGlue'},\n environment: {id: 'env-00000'},\n kafka_cluster: {id: 'lkc-00000'}\n }\n}));\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"content-type: application/json\");\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\ncurl_easy_setopt(hnd, CURLOPT_POSTFIELDS, \"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\"}}}\");\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}\");\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"content-type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nrequest.AddParameter(\"application/json\", \"{\\\"spec\\\":{\\\"display_name\\\":\\\"catalog_integration_1\\\",\\\"suspended\\\":false,\\\"config\\\":{\\\"kind\\\":\\\"AwsGlue\\\"},\\\"environment\\\":{\\\"id\\\":\\\"env-00000\\\"},\\\"kafka_cluster\\\":{\\\"id\\\":\\\"lkc-00000\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);"
}
]
},
"delete": {
"operationId": "deleteTableflowV1CatalogIntegration",
"summary": "Delete a Catalog Integration",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nMake 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"
}
},
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl --request DELETE \\\n --url 'https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000' \\\n --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\")\n .delete(null)\n .addHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n .build();\n\nResponse 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/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\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\n\nconn = http.client.HTTPSConnection(\"api.confluent.cloud\")\n\nheaders = { 'Authorization': \"Basic REPLACE_BASIC_AUTH\" }\n\nconn.request(\"DELETE\", \"/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Node",
"source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.confluent.cloud\",\n \"port\": null,\n \"path\": \"/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\",\n \"headers\": {\n \"Authorization\": \"Basic REPLACE_BASIC_AUTH\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"
},
{
"lang": "C",
"source": "CURL *hnd = curl_easy_init();\n\ncurl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_easy_setopt(hnd, CURLOPT_URL, \"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\");\n\nstruct curl_slist *headers = NULL;\nheaders = curl_slist_append(headers, \"Authorization: Basic REPLACE_BASIC_AUTH\");\ncurl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);\n\nCURLcode ret = curl_easy_perform(hnd);"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id}?environment=env-00000&spec.kafka_cluster=lkc-00000\");\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\");\nIRestResponse response = client.Execute(request);"
}
]
}
}
},
"components": {
"schemas": {
"iam.v2.ApiKey": {
"type": "object",
"description": "`ApiKey` objects represent access to different parts of Confluent Cloud. Some types\nof API keys represent access to a single cluster/resource such as a Kafka cluster,\nSchema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization\nthat are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API.\nTableflow API keys are not tied to a specific cluster.\n\nThe API allows you to list, create, update and delete your API Keys.\n\n\nRelated guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html).\n\n## The API Keys Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.ApiKey\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\nof API keys represent access to a single cluster/resource such as a Kafka cluster,\nSchema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization\nthat are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API.\nTableflow API keys are not tied to a specific cluster.\n\nThe API allows you to list, create, update and delete your API Keys.\n\n\nRelated guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html).\n\n## The API Keys Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.ApiKey\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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),\nSchema Registry Cluster ID (example: lsrc-12345), ksqlDB Cluster ID (example: lksqlc-12345), or Flink\n(Environment + Region pair, example: env-abc123.aws.us-east-2).\nMay be null or omitted if not associated with a resource. For creating Cloud API key, resource should be `CLOUD`,\nfor creating Tableflow API key, resource should be `TABLEFLOW`. The resource id is case-insensitive.\n[Learn more in Authentication](https://docs.confluent.io/cloud/current/api.html#section/Authentication).\n\nNote - Flink is in the [Preview lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)\n",
"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\nfor organizational purposes.\n\nThe API allows you to create, delete, and update your environments. You can retrieve\nindividual environments as well as a list of all your environments.\n\n\nRelated guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html).\n\n## The Environments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/org.v2.Environment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\nresources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing\nagreement (including any annual commitment or support plan).\n\nThe API allows you to list, view, and update your organizations.\n\n\nRelated guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html).\n\n## The Organizations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/org.v2.Organization\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\n",
"type": "object",
"properties": {
"package": {
"type": "string",
"x-extensible-enum": ["ESSENTIALS", "ADVANCED"],
"description": "Stream Governance Package. Supported values are ESSENTIALS and ADVANCED.\nPackage comparison can be found\n[here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type).\n"
}
},
"required": ["package"]
},
"org.v2.EnvironmentList": {
"type": "object",
"description": "`Environment` objects represent an isolated namespace for your Confluent resources\nfor organizational purposes.\n\nThe API allows you to create, delete, and update your environments. You can retrieve\nindividual environments as well as a list of all your environments.\n\n\nRelated guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html).\n\n## The Environments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/org.v2.Environment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\nresources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing\nagreement (including any annual commitment or support plan).\n\nThe API allows you to list, view, and update your organizations.\n\n\nRelated guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html).\n\n## The Organizations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/org.v2.Organization\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n\nThe API allows you to retrieve, update, and delete individual users, as well as list of all your\nusers. This API cannot be used to create new user accounts.\n\n\nRelated guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html).\n\n## The Users Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.User\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\nthat may access your Confluent resources.\n\nThe API allows you to create, retrieve, update, and delete individual service accounts, as well as\nlist all your service accounts.\n\n\nRelated guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html).\n\n## The Service Accounts Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.ServiceAccount\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n\nThe API allows you to list all your invitations, as well as create, read, and delete a specified invitation.\n\n\nRelated guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html).\n\n## The Invitations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.Invitation\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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",
"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)\ncan invite AUTH_TYPE_LOCAL users to SSO organizations.\nThe user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled.\nOtherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.\n",
"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.\n\nThe API allows you to retrieve, update, and delete individual users, as well as list of all your\nusers. This API cannot be used to create new user accounts.\n\n\nRelated guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html).\n\n## The Users Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.User\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\nthat may access your Confluent resources.\n\nThe API allows you to create, retrieve, update, and delete individual service accounts, as well as\nlist all your service accounts.\n\n\nRelated guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html).\n\n## The Service Accounts Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.ServiceAccount\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n\nThe API allows you to list all your invitations, as well as create, read, and delete a specified invitation.\n\n\nRelated guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html).\n\n## The Invitations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.Invitation\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n\n\n## The IP Groups Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IpGroup\" />",
"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\nany of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.\n"
},
"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).\nFor example, a binding between \"CorpNet\" and \"Management APIs\" will enforce that\naccess must come from one of the CIDR blocks associated with CorpNet.\nIf there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks\nfor any of the IP Group will allow the request.\nIf there are no IP Filters for a resource, then access will be granted to requests originating\nfrom any IP Address.\n\n\n## The IP Filters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IpFilter\" />",
"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,\nor any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.\n"
},
"resource_group": {
"type": "string",
"example": "management",
"description": "Scope of resources covered by this IP filter. Available resource groups include \"management\" and \"multiple\".\n"
},
"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\nor environment. Without specifying this property, the ip filter\nwould apply to the whole organization.\n"
},
"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'\nin order to use this property.During update operations, note that the operation\ngroups passed in will replace the list of existing operation groups\n(passing in an empty list will remove all operation groups) from the filter\n(in line with the behavior for ip_groups).\n"
},
"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.\nThis API can be queried in the context of an organization or an environment. It returns a\nsummary of every operation group in the system grouped with a higher summary by operation\ngroup category.\n",
"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.\n"
}
}
},
"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.\n\n\n## The IP Groups Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IpGroup\" />",
"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).\nFor example, a binding between \"CorpNet\" and \"Management APIs\" will enforce that\naccess must come from one of the CIDR blocks associated with CorpNet.\nIf there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks\nfor any of the IP Group will allow the request.\nIf there are no IP Filters for a resource, then access will be granted to requests originating\nfrom any IP Address.\n\n\n## The IP Filters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IpFilter\" />",
"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.\n\nThe API allows you to perform create, delete, and list operations on role bindings.\n\n\nRelated guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html).\n\n## The Role Bindings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.RoleBinding\" />",
"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.\n\nThe API allows you to perform create, delete, and list operations on role bindings.\n\n\nRelated guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html).\n\n## The Role Bindings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.RoleBinding\" />",
"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.\nA subscription is created for a particular `NotificationType` and the user will get notifications on the\n`Integrations` that are provided while creating the subscription.\n\nThis API allows you to create, retrieve, and update subscriptions,\nas well as to view the list of all your subscriptions. You can also delete subscriptions\nwith RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Subscriptions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.Subscription\" />",
"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\nnotification on the configured Integrations. If the subscription is DISABLED, the user will not\nrecieve any notification for the configured notification type. Note that, you cannot disable\na subscription for `REQUIRED` notification type.\n",
"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\na subscription. Please note that you can only perform create, update and delete operations for integrations\nof type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail`\nand `UserEmail`.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.Integration\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\n",
"example": "Slack integration"
},
"description": {
"type": "string",
"maxLength": 128,
"description": "A human readable description for the particular integration\n",
"example": "A Slack channel integration"
},
"target": {
"description": "Integration-specific details (integration targets)\n",
"allOf": [
{
"$ref": "#/components/schemas/notifications.v1.Target"
}
]
}
}
},
"notifications.v1.NotificationType": {
"type": "object",
"description": "The type of notifications (and their corresponding metadata) supported by Confluent.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Notification Types Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.NotificationType\" />",
"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\n",
"example": "Cluster Shrink"
},
"category": {
"type": "string",
"x-extensible-enum": [
"BILLING_LICENSING",
"SECURITY",
"SERVICE",
"ACCOUNT"
],
"description": "Represents the group with which the notification is associated.\nNotifications are grouped under certain categories for better organization.\n- BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here.\n- SECURITY: All Confluent Cloud and Platform security related notifications are grouped here.\n- SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are\n grouped here.\n- ACCOUNT: All Confluent account related notifications are grouped here.\nFor example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category.\n",
"example": "BILLING_LICENSING"
},
"description": {
"type": "string",
"description": "Human readable description of the notification type\n",
"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.\n- REQUIRED: the user is auto-subscribed to this notification and can't opt-out.\n- RECOMMENDED: the user is auto-subscribed to this notification and can opt-out.\n- OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it.\n",
"example": "REQUIRED"
},
"is_included_in_plan": {
"type": "boolean",
"description": "Whether this notification is available to subscribe or not\nas per the user's current billing plan.\n"
},
"severity": {
"type": "string",
"x-extensible-enum": ["CRITICAL", "WARN", "INFO"],
"description": "Severity indicates the impact of this notification.\n- CRITICAL: a high impact notification which needs immediate attention.\n- WARN: a warning notification which can be addressed now or later.\n- INFO: an informational notification.\n",
"example": "INFO"
}
}
},
"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": {
"type": "string",
"description": "ID of the user",
"example": "u-temp1"
}
}
},
"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}"
}
},
"notifications.v1.SubscriptionList": {
"type": "object",
"description": "`Subscription` objects represent the intent of the customers to get notifications of particular types.\nA subscription is created for a particular `NotificationType` and the user will get notifications on the\n`Integrations` that are provided while creating the subscription.\n\nThis API allows you to create, retrieve, and update subscriptions,\nas well as to view the list of all your subscriptions. You can also delete subscriptions\nwith RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Subscriptions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.Subscription\" />",
"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\na subscription. Please note that you can only perform create, update and delete operations for integrations\nof type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail`\nand `UserEmail`.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.Integration\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Notification Types Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.NotificationType\" />",
"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
}
}
},
"cmk.v2.Cluster": {
"type": "object",
"description": "`Clusters` objects represent Apache Kafka Clusters on Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your Kafka clusters.\n\n\nRelated guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cmk.v2.Cluster\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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:\n PROVISIONED: cluster is provisioned;\n PROVISIONING: cluster provisioning is in progress;\n FAILED: provisioning failed\n",
"readOnly": true,
"example": "PROVISIONED"
},
"cku": {
"description": "The number of Confluent Kafka Units (CKUs) the Dedicated cluster currently has.\n",
"readOnly": true,
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 2
}
},
"readOnly": true
},
"cmk.v2.Basic": {
"type": "object",
"description": "The basic cluster type.\n",
"properties": {
"kind": {
"description": "Basic cluster type.\n",
"type": "string",
"enum": ["Basic"]
}
},
"required": ["kind"]
},
"cmk.v2.Standard": {
"type": "object",
"description": "The standard cluster type.\n",
"properties": {
"kind": {
"description": "Standard cluster type.\n",
"type": "string",
"enum": ["Standard"]
}
},
"required": ["kind"]
},
"cmk.v2.Enterprise": {
"type": "object",
"description": "The enterprise cluster type.\n",
"properties": {
"kind": {
"description": "Enterprise cluster type.\n",
"type": "string",
"enum": ["Enterprise"]
}
},
"required": ["kind"]
},
"cmk.v2.Dedicated": {
"type": "object",
"description": "A dedicated cluster with its parameters.\n",
"properties": {
"kind": {
"type": "string",
"enum": ["Dedicated"],
"description": "Dedicated cluster type.\n"
},
"cku": {
"description": "The number of Confluent Kafka Units (CKUs) for Dedicated cluster types.\nMULTI_ZONE dedicated clusters must have at least two CKUs.\n",
"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.\n(e.g. for Amazon Web Services, the Amazon Resource Name of the key).\n",
"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.\n\nOn AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n (e.g. us-central1-c).\n",
"readOnly": true,
"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.\n",
"properties": {
"kind": {
"type": "string",
"enum": ["Freight"],
"description": "Freight cluster type.\n"
},
"zones": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"minItems": 1,
"maxItems": 3,
"description": "The list of zones the cluster is in.\n\nOn AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n (e.g. us-central1-c).\n",
"readOnly": true,
"example": ["us-central1-a", "us-central1-b", "us-central1-c"],
"x-immutable": true
}
},
"required": ["kind"]
},
"cmk.v2.ClusterList": {
"type": "object",
"description": "`Clusters` objects represent Apache Kafka Clusters on Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your Kafka clusters.\n\n\nRelated guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cmk.v2.Cluster\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\n",
"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.\n\nNote: Clusters can be upgraded from Basic to Standard, but cannot be downgraded from Standard to Basic.\n",
"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.",
"example": "lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092",
"x-immutable": true,
"readOnly": true
},
"http_endpoint": {
"type": "string",
"description": "The cluster HTTP request URL.",
"format": "uri",
"example": "https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud",
"x-immutable": true,
"readOnly": true
},
"api_endpoint": {
"type": "string",
"description": "The Kafka API cluster endpoint used by Kafka clients to connect to the cluster.",
"example": "https://pkac-00000.us-west-2.aws.confluent.cloud",
"x-immutable": true,
"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": "The byok associated with this object.",
"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.\nIt executes SQL statements and queries which under the hood get built into corresponding\nKafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters.\n\n\nRelated guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/ksqldbcm.v2.Cluster\" />\n\n## Quotas and Limits\nThis resource is subject to the following quotas:\n\n| Quota | Description |\n| --- | --- |\n| `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.\nIt executes SQL statements and queries which under the hood get built into corresponding\nKafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters.\n\n\nRelated guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/ksqldbcm.v2.Cluster\" />\n\n## Quotas and Limits\nThis resource is subject to the following quotas:\n\n| Quota | Description |\n| --- | --- |\n| `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,31}$",
"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\ndon't want to emit sensitive information to the processing log\n",
"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\nare the minimum set of key-value pairs (KVP) which can be used to\ndefine how the connector connects Kafka to the external system.\nSome of these KVPs are common to all the connectors, such as\nconnection parameters to Kafka, connector metadata, etc. The list\nof common connector configurations is as follows\n\n- cloud.environment\n- cloud.provider\n- connector.class\n- kafka.api.key\n- kafka.api.secret\n- kafka.endpoint\n- kafka.region\n- name\n\nA specific connector such as `GcsSink` would have additional\nparameters 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\nare the minimum set of key-value pairs which can be used to\ndefine how the connector connects Kafka to the external system.\nSome of these key-value pairs are common to all the connectors, such as\nconnection parameters to Kafka, connector metadata, etc. The list\nof common connector configurations is as follows\n- cloud.environment\n- cloud.provider\n- connector.class\n- kafka.api.key\n- kafka.api.secret\n- kafka.endpoint\n- kafka.region\n- name\nA specific connector such as `GcsSink` would have additional\nparameters 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\nare the minimum set of key-value pairs (KVP) which can be used to\ndefine how the connector connects Kafka to the external system.\nSome of these KVPs are common to all the connectors, such as\nconnection parameters to Kafka, connector metadata, etc. The list\nof common connector configurations is as follows\n\n - cloud.environment\n - cloud.provider\n - connector.class\n - kafka.api.key\n - kafka.api.secret\n - kafka.endpoint\n - kafka.region\n - name\n\nA specific connector such as `GcsSink` would have additional\nparameters 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\nare the minimum set of key-value pairs (KVP) which are used to\ndefine how the connector connects Kafka to the external system.\nSome of these KVPs are common to all the connectors, such as\nconnection parameters to Kafka, connector metadata, etc. The list\nof common connector configurations is as follows\n\n - cloud.environment\n - cloud.provider\n - connector.class\n - kafka.api.key\n - kafka.api.secret\n - kafka.endpoint\n - kafka.region\n - name\n\nFor example, a connector like `GcsSink` would have additional\nparameters 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 \npartition. For source connectors this is depends on the partitions defined by the \nsource connector. For example, the table which this task is pulling data from in a\nJDBC based MySQL source connector.\nPlease refer to the [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) for \nmore information."
},
"offset": {
"type": "object",
"additionalProperties": true,
"description": "The offset of the partition. For sink connectors this is the kafka offset. For \nsource connectors this is depends on the offset defined by the source connector. \nFor example, the timestamp and incrementing column info in a table, for a JDBC based \nMySQL source connector.\nPlease refer to the [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) for \nmore 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.\nThe update will only happen for the partitions provided in the request. \nDELETE will delete the offset for the provided partitions and reset them back to the\nbase state. It is as if, a fresh new connector was created.\n\nFor sink connectors PATCH/DELETE will move the offsets to the provided point in the \ntopic partition. If the offset provided is not present in the topic partition it will\nby default reset to the earliest offset in the topic partition.\n\nFor source connectors, post PATCH/DELETE the connector will attempt to read from the \nposition 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 \nis the offsets that the connector last processed, before the offsets were altered,\nvia 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. \n\nPENDING: The offset alter operation is in progress.\n\nAPPLIED: The offset alter operation has been applied to the connector.\n\nFAILED: 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.\nThe API allows you to list, create, read, update, and delete your Custom Connector Plugins.\nRelated guide:\n[Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html).\n\n\n## The Custom Connector Plugins Model\n<SchemaDefinition schemaRef=\"#/components/schemas/connect.v1.CustomConnectorPlugin\" />",
"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]*)$",
"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.\n",
"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",
"oneOf": [
{
"$ref": "#/components/schemas/connect.v1.UploadSource.PresignedUrl"
}
],
"description": "[immutable] 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"
}
}
}
}
},
"connect.v1.PresignedUrl": {
"type": "object",
"description": "Request a presigned upload URL for new Custom Connector Plugin. Note that\nthe URL policy expires in one hour. If the policy expires, you can request\na new presigned upload URL.\n\nRelated guide:\n[Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html).\n\n\n## The Presigned Urls Model\n<SchemaDefinition schemaRef=\"#/components/schemas/connect.v1.PresignedUrl\" />",
"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",
"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.PresignedUrlRequest": {
"type": "object",
"description": "Request schema of the presigned upload URL.\n",
"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.\n",
"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.CustomConnectorPluginList": {
"type": "object",
"description": "CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud.\nThe API allows you to list, create, read, update, and delete your Custom Connector Plugins.\nRelated guide:\n[Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html).\n\n\n## The Custom Connector Plugins Model\n<SchemaDefinition schemaRef=\"#/components/schemas/connect.v1.CustomConnectorPlugin\" />",
"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
}
}
},
"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"
}
}
}
}
]
},
"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"
]
},
"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
}
}
},
"TopicConfigData": {
"allOf": [
{
"$ref": "#/components/schemas/AbstractConfigData"
},
{
"type": "object",
"required": ["topic_name"],
"properties": {
"topic_name": {
"type": "string"
}
}
}
]
},
"TopicConfigDataList": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceCollection"
},
{
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicConfigData"
}
}
}
}
]
},
"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"
}
}
},
"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"
}
}
}
}
]
},
"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",
"default",
"read_only",
"sensitive",
"source",
"synonyms",
"link_name"
],
"properties": {
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"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"
},
"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"
},
"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.\nUse this API to retrieve an individual quota or list of quotas for a given scope.\n\n\nRelated guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html).\n\n## The Applied Quotas Model\n<SchemaDefinition schemaRef=\"#/components/schemas/service-quota.v1.AppliedQuota\" />",
"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.\n"
},
"applied_limit": {
"type": "integer",
"format": "int32",
"description": "The latest applied service quota value, taking into account any limit adjustments.\n"
},
"usage": {
"type": "integer",
"description": "Show the quota usage value if the quota usage is available for this quota.\n",
"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.\n",
"x-immutable": true
},
"network": {
"allOf": [
{
"$ref": "#/components/schemas/EnvScopedObjectReference"
}
],
"nullable": true,
"description": "The network ID the quota is associated with.\n",
"x-immutable": true
},
"kafka_cluster": {
"allOf": [
{
"$ref": "#/components/schemas/EnvScopedObjectReference"
}
],
"nullable": true,
"description": "The kafka cluster ID the quota is associated with.\n",
"x-immutable": true
}
}
},
"service-quota.v1.Scope": {
"type": "object",
"description": "Gets a list of all available scopes for applied quotas.\n\n\nRelated guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes).\n\n## The Scopes Model\n<SchemaDefinition schemaRef=\"#/components/schemas/service-quota.v1.Scope\" />",
"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.\nUse this API to retrieve an individual quota or list of quotas for a given scope.\n\n\nRelated guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html).\n\n## The Applied Quotas Model\n<SchemaDefinition schemaRef=\"#/components/schemas/service-quota.v1.AppliedQuota\" />",
"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.\n\n\nRelated guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes).\n\n## The Scopes Model\n<SchemaDefinition schemaRef=\"#/components/schemas/service-quota.v1.Scope\" />",
"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\na different ID, otherwise, same as external_id)\n",
"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.\nThe API allows you to list Schema Registry regions.\n\n\nRelated guides:\n* [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support).\n* [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).\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v2.Region\" />",
"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.\n\nThe API allows you to list, create, read, and delete your Schema Registry clusters.\n\n\nRelated guides:\n* [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management).\n* [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).\n\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v2.Cluster\" />",
"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:\n\n PROVISIONED: cluster is provisioned;\n\n PROVISIONING: cluster provisioning is in progress;\n\n FAILED: provisioning failed\n\nNote: Schema Registry Cluster Management is handled through the org/v2 Environments API as of srcm/v3.\n",
"readOnly": true,
"example": "PROVISIONED"
}
},
"readOnly": true
},
"srcm.v2.RegionList": {
"type": "object",
"description": "`Region` objects represent cloud provider regions available when placing Schema Registry clusters.\nThe API allows you to list Schema Registry regions.\n\n\nRelated guides:\n* [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support).\n* [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).\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v2.Region\" />",
"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.\n\nThe API allows you to list, create, read, and delete your Schema Registry clusters.\n\n\nRelated guides:\n* [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management).\n* [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).\n\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v2.Cluster\" />",
"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.\n\nNote: Clusters can be upgraded from ESSENTIALS to ADVANCED, but cannot be\ndowngraded from ADVANCED to ESSENTIALS.\n",
"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.\n\nThe API allows you to list and read your Schema Registry clusters.\n\n\nRelated guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v3.Cluster\" />",
"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:\n\n PROVISIONED: cluster is provisioned;\n\n PROVISIONING: cluster provisioning is in progress;\n\n FAILED: provisioning failed\n",
"readOnly": true,
"example": "PROVISIONED"
}
},
"readOnly": true
},
"srcm.v3.ClusterList": {
"type": "object",
"description": "`Clusters` objects represent Schema Registry Clusters on Confluent Cloud.\n\nThe API allows you to list and read your Schema Registry clusters.\n\n\nRelated guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v3.Cluster\" />",
"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.\n\nNote: Clusters can be upgraded from ESSENTIALS to ADVANCED, but cannot be\ndowngraded from ADVANCED to ESSENTIALS.\n",
"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.\n\nDEPRECATED - Please use the `private_networking_config.regional_endpoints` attribute instead,\nwhich supersedes the `private_http_endpoint` attribute.\n",
"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"
}
},
"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"
}
},
"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": "<Physical SR Endpoint>"
},
"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"
}
},
"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\nnamed by the alias. That means that any reference to this subject\nwill be replaced by the alias."
},
"normalize": {
"type": "boolean",
"description": "If true, then schemas are automatically normalized when registered or\nwhen passed during lookups. This means that clients do not have to\npass 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\nchecked 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\nnamed by the alias. That means that any reference to this subject\nwill be replaced by the alias."
},
"normalize": {
"type": "boolean",
"description": "If true, then schemas are automatically normalized when registered\nor when passed during lookups. This means that clients do not have\nto 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\nchecked 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"
}
},
"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"
}
},
"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"
},
"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\n(topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing.\n\n\n## The Provider Shared Resources Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />",
"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.\n\n\nRelated guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares).\n\n## The Provider Shares Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderShare\" />",
"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\n(topic, schema registry subjects, sharing metadata) that you received through Stream Sharing.\n\n\n## The Consumer Shared Resources Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerSharedResource\" />",
"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,\nthen the list will be empty\n",
"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.\n\n\nRelated guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html).\n\n## The Consumer Shares Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerShare\" />",
"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\n\n\n## The Shared Tokens Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.SharedToken\" />",
"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\n\n## The Opt Ins Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.OptIn\" />",
"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\nused with PrivateLink. Otherwise, they are automatically chosen by Confluent Cloud.\n\nOn AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n (e.g. us-central1-c).\n\nOn Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not\n have universal zone identifiers.\n",
"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\nvalues are DNS domains.\n",
"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\nand values are [Azure PrivateLink Service\nAliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service)\n",
"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\nAttachments if available. Keys are zones and values are\n[GCP Private Service Connect Service\nAttachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7)\n",
"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.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"
},
"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\n(topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing.\n\n\n## The Provider Shared Resources Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />",
"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.\n\n\nRelated guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares).\n\n## The Provider Shares Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderShare\" />",
"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\n(topic, schema registry subjects, sharing metadata) that you received through Stream Sharing.\n\n\n## The Consumer Shared Resources Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerSharedResource\" />",
"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.\n\n\nRelated guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html).\n\n## The Consumer Shares Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerShare\" />",
"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"
}
}
},
"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"
},
"networking.v1.Network": {
"type": "object",
"description": "`Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud\nprovider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters.\nShared networks can contain any cluster type.\n\nThe API allows you to list, create, read, update, and delete your networks.\n\n\nRelated guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html).\n\n## The Networks Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Network\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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:\n\nPROVISIONING: network provisioning is in progress;\n\nREADY: network is ready;\n\nFAILED: provisioning failed;\n\nDEPROVISIONING: network deprovisioning is in progress;\n",
"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
},
"zonal_subdomains": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and\nvalues are DNS domains.\n",
"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",
"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.\n\nRelated guides:\n* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).\n* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).\n* [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html).\n\n\n## The Peerings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Peering\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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:\n\n PROVISIONING: peering provisioning is in progress;\n\n PENDING_ACCEPT: peering connection request is pending acceptance by the customer;\n\n READY: peering is ready;\n\n FAILED: peering is in a failed state;\n\n DEPROVISIONING: peering deprovisioning is in progress;\n\n DISCONNECTED: peering has been disconnected in the cloud provider by the customer;\n",
"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.TransitGatewayAttachment": {
"type": "object",
"description": "AWS Transit Gateway Attachments\n\nRelated guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html).\n\n## The Transit Gateway Attachments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.TransitGatewayAttachment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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:\n\n PROVISIONING: attachment provisioning is in progress;\n\n PENDING_ACCEPT: attachment request is pending acceptance by the customer;\n\n READY: attachment is ready;\n\n FAILED: attachment is in a failed state;\n\n DEPROVISIONING: attachment deprovisioning is in progress;\n\n DISCONNECTED: attachment was manually deleted directly in the cloud provider by the customer;\n\n ERROR: invalid customer input during attachment creation.\n",
"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",
"oneOf": [
{
"$ref": "#/components/schemas/networking.v1.AwsTransitGatewayAttachmentStatus"
}
],
"description": "The cloud-specific TGW attachment details.",
"discriminator": {
"propertyName": "kind",
"mapping": {
"AwsTransitGatewayAttachmentStatus": "#/components/schemas/networking.v1.AwsTransitGatewayAttachmentStatus"
}
},
"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.\n\nRelated guides:\n* [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html).\n* [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html).\n* [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).\n\n\n## The Private Link Accesses Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAccess\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `private_link_accounts_per_network` | Number of AWS accounts per network |\n| `private_link_subscriptions_per_network` | Number of Azure subscriptions per network |\n| `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:\n\n PROVISIONING: PrivateLink access provisioning is in progress;\n\n READY: PrivateLink access is ready;\n\n FAILED: PrivateLink access is in a failed state;\n\n DEPROVISIONING: PrivateLink access deprovisioning is in progress;\n",
"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.NetworkLinkService": {
"type": "object",
"description": "Network Link Service is associated with a Private Link Confluent Cloud Network.\nIt enables connectivity from other Private Link Confluent Cloud Networks based on\nthe configured accept policies.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Services Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkService\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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:\n\nREADY: network link service is ready;\n",
"readOnly": true,
"example": "READY"
},
"error_code": {
"type": "string",
"description": "Error code if network link service is in a failed state.\nMay be used for programmatic error checking.\n",
"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\nNetwork Link Service (associated with another Private Link Confluent Cloud Network) at the target.\nIt enables connectivity between the origin network and the target network.\nIt can only be associated with a Private Link network.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Endpoints Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkEndpoint\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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:\n\n PROVISIONING: network link endpoint provisioning is in progress;\n\n PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target;\n\n READY: network link endpoint is ready;\n\n FAILED: network link endpoint is in a failed state;\n\n DEPROVISIONING: network link endpoint deprovisioning is in progress;\n\n EXPIRED: network link endpoint request is expired, can only be deleted;\n\n DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions;\n\n DISCONNECTING: network link endpoint disconnection is in progress;\n\n INACTIVE: network link endpoint is created, but not active since there are no clusters in the network;\n",
"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.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Service Associations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkServiceAssociation\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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:\n\n PROVISIONING: network link endpoint provisioning is in progress;\n\n PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target;\n\n READY: network link endpoint is ready;\n\n FAILED: network link endpoint is in a failed state;\n\n DEPROVISIONING: network link endpoint deprovisioning is in progress;\n\n EXPIRED: network link endpoint request is expired, can only be deleted;\n\n DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions;\n\n DISCONNECTING: network link endpoint disconnection is in progress;\n\n INACTIVE: network link endpoint is created, but not active since there are no clusters in the network;\n",
"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",
"description": "The mapping of zones to Private Service Connect Service\nAttachments if available. Keys are zones and values are\n[GCP Private Service Connect Service\nAttachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7)\n",
"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\nand values are [Azure Private Link Service\nAliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service).\n",
"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\nand values are [Azure Private Link Service Resource\nIDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service).\n",
"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\nwith Confluent Cloud network. This is used by Confluent Cloud network to route traffic back to your network.\nThe CIDR block must be a private range and cannot overlap with the Confluent Cloud CIDR block.\n",
"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.\n",
"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\n[Importing custom routes](https://cloud.google.com/vpc/docs/vpc-peering#importing-exporting-routes).\n",
"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.\nRepresents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal\nunder\n[Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview).\nMust be a valid **32 character UUID string**.\n"
},
"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.\nYou can find your AWS account ID [here](https://console.aws.amazon.com/billing/home?#/account)\nunder **My Account** in your AWS Management Console. Must be a **12 character string**.\n"
}
}
},
"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\nAzure Private Link. You can find your Azure subscription ID in the subscription section of your\n[Microsoft Azure Portal](https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade).\nMust be a valid **32 character UUID string**.\n"
}
}
},
"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\nusing Private Service Connect. You can find your Google Cloud Project ID under **Project ID** section of\nyour [Google Cloud Console dashboard](https://console.cloud.google.com/home/dashboard).\n"
}
}
},
"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.\n",
"properties": {
"environments": {
"description": "List of environments from which connections can be accepted.\nAll networks win the list of environment will be allowed.\n",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"networks": {
"description": "List of networks from which connections can be accepted.\n",
"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"
},
"cidr": {
"description": "The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to used for this network.\nMust be a `/27`. Required for VPC peering and AWS TransitGateway.\n",
"type": "string",
"example": "10.20.0.0/27"
}
}
},
"networking.v1.NetworkList": {
"type": "object",
"description": "`Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud\nprovider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters.\nShared networks can contain any cluster type.\n\nThe API allows you to list, create, read, update, and delete your networks.\n\n\nRelated guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html).\n\n## The Networks Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Network\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\nMust be `/16`. Required for VPC peering and AWS TransitGateway.\n",
"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\nused with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP\nnetworks used with Peering.\nOtherwise, they are automatically chosen by Confluent Cloud.\n\nOn AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n (e.g. us-central1-c).\n\nOn Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not\n have universal zone identifiers.\n",
"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.\n\nNote - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)\n",
"x-immutable": true
},
"dns_config": {
"description": "DNS config only applies to PrivateLink network connection type.\n\nWhen resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS\n to resolve cluster endpoints.\n\nWhen resolution is PRIVATE, clusters in this network only require private DNS\n to resolve cluster endpoints.\n",
"allOf": [
{
"$ref": "#/components/schemas/networking.v1.DnsConfig"
}
],
"x-immutable": true
},
"reserved_cidr": {
"type": "string",
"description": "The reserved CIDR config is used only by AWS networks with connection_types = Vpc_Peering or Transit_Gateway\n\nAn IPv4 [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\n reserved for Confluent Cloud Network. Must be \\24.\n If not specified, Confluent Cloud Network uses 172.20.255.0/24\n\nNote - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)\n",
"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.\n\nRelated guides:\n* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).\n* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).\n* [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html).\n\n\n## The Peerings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Peering\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\n\nRelated guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html).\n\n## The Transit Gateway Attachments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.TransitGatewayAttachment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n\nRelated guides:\n* [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html).\n* [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html).\n* [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).\n\n\n## The Private Link Accesses Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAccess\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `private_link_accounts_per_network` | Number of AWS accounts per network |\n| `private_link_subscriptions_per_network` | Number of Azure subscriptions per network |\n| `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.\nIt enables connectivity from other Private Link Confluent Cloud Networks based on\nthe configured accept policies.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Services Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkService\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\nNetwork Link Service (associated with another Private Link Confluent Cloud Network) at the target.\nIt enables connectivity between the origin network and the target network.\nIt can only be associated with a Private Link network.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Endpoints Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkEndpoint\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Service Associations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkServiceAssociation\" />",
"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\n\nRelated guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html)\n\n## The IP Addresses Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.IpAddress\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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\n\nRelated guide: [Use Public Egress IP Addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html)\n\n## The IP Addresses Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.IpAddress\" />",
"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\nto a cloud region in order to access resources that belong to a Confluent Cloud Environment.\nThe API allows you to list, create, read update and delete your PrivateLink attachments.\n\n\n## The Private Link Attachments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAttachment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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:\n\n PROVISIONING: PrivateLink attachment provisioning is in progress;\n\n WAITING_FOR_CONNECTIONS: PrivateLink attachment is waiting for connections;\n\n READY: PrivateLink attachment is ready;\n\n FAILED: PrivateLink attachment is in a failed state;\n\n EXPIRED: PrivateLink attachment has timed out waiting for connections, can only be deleted;\n\n DEPROVISIONING: PrivateLink attachment deprovisioning is in progress;\n",
"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.",
"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\nin order to access resources that belong to a Confluent Cloud Environment.\nThe API allows you to list, create, read update and delete your PrivateLink attachment connections.\n\n\n## The Private Link Attachment Connections Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAttachmentConnection\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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:\n\n PROVISIONING: PrivateLink attachment connection provisioning is in progress;\n\n READY: PrivateLink attachment connection is ready;\n\n FAILED: PrivateLink attachment connection is in a failed state;\n\n DEPROVISIONING: PrivateLink attachment connection deprovisioning is in progress;\n\n DISCONNECTED:|\n PrivateLink attachment connection is in a disconnected state. This means the\n private endpoint associated with this PrivateLink attachment connection has been deleted;\n",
"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\nAWS VPC Endpoint Service that can be used to establish PrivateLink\nconnections.\n",
"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.\n",
"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.\n",
"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\nPrivateLink service that can be used to establish PrivateLink\n",
"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.\n",
"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.\n",
"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\nGCP PSC Service attachment. A PSC Endpoint can be connected to\nthe Service attachment.\n",
"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\nto a PSC Endpoint.\n",
"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\nconnect a PSC Endpoint.\n",
"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\nthe PrivateLink service.\n",
"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.\n",
"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.PrivateLinkAttachmentList": {
"type": "object",
"description": "PrivateLink attachment objects represent reservations to establish PrivateLink connections\nto a cloud region in order to access resources that belong to a Confluent Cloud Environment.\nThe API allows you to list, create, read update and delete your PrivateLink attachments.\n\n\n## The Private Link Attachments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAttachment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n",
"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\nusing the PrivateLink attachment are located.\n",
"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\nin order to access resources that belong to a Confluent Cloud Environment.\nThe API allows you to list, create, read update and delete your PrivateLink attachment connections.\n\n\n## The Private Link Attachment Connections Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAttachmentConnection\" />",
"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.\n\nThe API allows you to list, create, read, update, and delete your Identity Provider.\n\n\nRelated guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html).\n\n## The Identity Providers Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IdentityProvider\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `identity_providers_per_org` | Number of OAuth identity providers per organization |\n| `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\n[Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears\nin audit log records. Note: if the client specifies mapping to one identity pool ID, the identity\nclaim configured with that pool will be used instead.\nNote - The attribute is in an [Early Access lifecycle stage]\n(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\nidentity 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\nidentity provider. JWKS provides a set of crypotgraphic keys\nused to verify the authenticity and integrity of JSON Web\nTokens (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)\nand `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\nConfluent Cloud.\n\nThe API allows you to refresh JWKS public key data.\n\n\nRelated guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html).\n\n## The Jwks Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.Jwks\" />",
"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`\nthat authorizes them to Confluent Cloud resources.\n\nIt provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that\nis then used to provide access to Confluent Resources.\n\n\nRelated guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html).\n\n## The Identity Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IdentityPool\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\n(see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details).\nThis appears in the audit log records, showing, for example, that \"identity Z used identity pool X to access\ntopic 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.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.IdentityProviderList": {
"type": "object",
"description": "`IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your Identity Provider.\n\n\nRelated guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html).\n\n## The Identity Providers Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IdentityProvider\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `identity_providers_per_org` | Number of OAuth identity providers per organization |\n| `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`\nthat authorizes them to Confluent Cloud resources.\n\nIt provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that\nis then used to provide access to Confluent Resources.\n\n\nRelated guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html).\n\n## The Identity Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IdentityPool\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n",
"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\n",
"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\nis urn:ietf:params:oauth:token-type:jwt.\n",
"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.\nSupported values is urn:ietf:params:oauth:token-type:access_token.\n",
"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\nand the time when the access token will expire\n",
"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.\nClient application could use the access token to access confluent public api\n"
},
"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.\n\nThe API allows you to list, create, read, update, and delete your client quotas.\n\n\nRelated guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html).\n\n## The Client Quotas Model\n<SchemaDefinition schemaRef=\"#/components/schemas/kafka-quotas.v1.ClientQuota\" />",
"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."
}
}
},
"kafka-quotas.v1.ClientQuotaList": {
"type": "object",
"description": "`ClientQuota` objects represent Client Quotas you can set at the service account level.\n\nThe API allows you to list, create, read, update, and delete your client quotas.\n\n\nRelated guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html).\n\n## The Client Quotas Model\n<SchemaDefinition schemaRef=\"#/components/schemas/kafka-quotas.v1.ClientQuota\" />",
"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.\n",
"x-immutable": true
},
"principals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalObjectReference"
},
"description": "A list of principals to apply a client quota to.\nUse `\"<default>\"` to apply a client quota to all service accounts\n(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).\n",
"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.\n\nKeys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP.\nThis API allows you to upload and retrieve self-managed keys on Confluent Cloud.\n\n\nRelated guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html).\n\n## The Keys Model\n<SchemaDefinition schemaRef=\"#/components/schemas/byok.v1.Key\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\n\nFor AWS, provide the corresponding `key_arn`.\n\nFor Azure, provide the corresponding `key_id`.\n\nFor GCP, provide the corresponding `key_id`.\n",
"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
},
"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:\n AVAILABLE: key can be used for a Kafka cluster provisioning\n IN_USE: key is already in use by a Kafka cluster provisioning\n",
"readOnly": true,
"example": "IN_USE"
}
}
},
"byok.v1.AwsKey": {
"type": "object",
"description": "The AWS BYOK details\n",
"properties": {
"key_arn": {
"description": "The Amazon Resource Name (ARN) of an AWS KMS key.\n",
"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.\n",
"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.\n",
"type": "string",
"enum": ["AwsKey"],
"x-immutable": true
}
},
"required": ["key_arn", "kind"]
},
"byok.v1.AzureKey": {
"type": "object",
"description": "The Azure BYOK details.\n",
"properties": {
"application_id": {
"description": "The Application ID created for this key-environment combination.\n",
"type": "string",
"readOnly": true
},
"key_id": {
"description": "The unique Key Object Identifier URL without version of an Azure Key Vault key.\n",
"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\n",
"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.\n",
"type": "string",
"enum": ["AzureKey"],
"x-immutable": true
},
"tenant_id": {
"description": "Tenant ID (uuid) hosting the Key Vault containing the key\n",
"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\n",
"properties": {
"key_id": {
"description": "The Google Cloud Platform key ID.\n",
"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.\n",
"type": "string",
"example": "testgroupid@domain.com",
"readOnly": true
},
"kind": {
"description": "BYOK kind type.\n",
"type": "string",
"enum": ["GcpKey"],
"x-immutable": true
}
},
"required": ["key_id", "kind"]
},
"byok.v1.KeyList": {
"type": "object",
"description": "`Key` objects represent customer managed keys on dedicated Confluent Cloud clusters.\n\nKeys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP.\nThis API allows you to upload and retrieve self-managed keys on Confluent Cloud.\n\n\nRelated guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html).\n\n## The Keys Model\n<SchemaDefinition schemaRef=\"#/components/schemas/byok.v1.Key\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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"]
}
]
},
"uniqueItems": true
}
}
},
"billing.v1.Cost": {
"type": "object",
"description": "`Cost` objects represent the aggregated billing costs for an organization\n\n\nRelated guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates).\n\n## The Costs Model\n<SchemaDefinition schemaRef=\"#/components/schemas/billing.v1.Cost\" />",
"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"
],
"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",
"SUPPORT_CLOUD_BASIC",
"SUPPORT_CLOUD_DEVELOPER",
"SUPPORT_CLOUD_BUSINESS",
"SUPPORT_CLOUD_PREMIER"
],
"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"
],
"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."
},
"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),\nConnector ID (example:\n lcc-12345), Schema Registry Cluster ID (example: lsrc-12345), or ksqlDB Cluster ID\n(example: lksqlc-12345).\nMay be null or omitted if not associated with a resource.\n",
"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.\n",
"properties": {
"id": {
"type": "string",
"description": "ID of the environment.",
"example": "env-123"
}
}
},
"billing.v1.CostList": {
"type": "object",
"description": "`Cost` objects represent the aggregated billing costs for an organization\n\n\nRelated guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates).\n\n## The Costs Model\n<SchemaDefinition schemaRef=\"#/components/schemas/billing.v1.Cost\" />",
"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\nidentity provider and specific RBAC roles in Confluent Cloud.\n\nGroup mappings enable automated and secure access control to Confluent Cloud resources,\nreducing administrative workload by streamlining user provisioning and authorization.\n\n\nRelated guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html).\n\n## The Group Mappings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.sso.GroupMapping\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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",
"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\nidentity provider and specific RBAC roles in Confluent Cloud.\n\nGroup mappings enable automated and secure access control to Confluent Cloud resources,\nreducing administrative workload by streamlining user provisioning and authorization.\n\n\nRelated guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html).\n\n## The Group Mappings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.sso.GroupMapping\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.\nThe resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it.\nNote that the Compute Pool API supports a limited pagination API, only the `next` field will be populated.\n\n\n## The Compute Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/fcpm.v2.ComputePool\" />",
"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.\nThe API allows you to list Flink regions.\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/fcpm.v2.Region\" />",
"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.ComputePoolList": {
"type": "object",
"description": "A Compute Pool represents a set of compute resources that is used to run your Queries.\nThe resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it.\nNote that the Compute Pool API supports a limited pagination API, only the `next` field will be populated.\n\n\n## The Compute Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/fcpm.v2.ComputePool\" />",
"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.\n",
"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\nlifecycle stage only.\n",
"x-immutable": true
},
"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.\nThe API allows you to list Flink regions.\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/fcpm.v2.Region\" />",
"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.Connection": {
"type": "object",
"description": "`Connection` models a reusable endpoint and auth token to authenticate the caller to\nuse that endpoint.\nOnly `OrgAdmins` and `EnvAdmins` will have the permissions to create, update and delete `Connections`. \n`FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model \ncreation statements. \nThe API allows you to list, create, read, and delete your connections.\n## The Connections Model\n<SchemaDefinition schemaRef=\"#/components/schemas/sql.v1.Connection\" />",
"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\nuse that endpoint.\nOnly `OrgAdmins` and `EnvAdmins` will have the permissions to create, update and delete `Connections`.\n`FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model\ncreation statements.\nThe API allows you to list, create, read, and delete your connections.\n## The Connection Model\n<SchemaDefinition schemaRef=\"#/components/schemas/sql.v1.Connection\" />",
"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:\n\nREADY: The Connection is usable;\n\nUNREACHABLE: The Connection endpoint is unreachable;\n\nINVALID_AUTH: The Connection auth token is invalid;\n",
"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.\n\nConfluent only accepts authentication tokens of supported model providers from OrgAdmins and EnvAdmins.\nFor now, only 'PlainText' provider is supported. It stores authentication token details as opaque bytes in an encrypted form.\nThis option offers limited security as it only provides a single level of encryption.\n",
"properties": {
"kind": {
"description": "Plaintext Provider Kind Type\n",
"type": "string",
"enum": ["PlaintextProvider"],
"x-immutable": true
},
"data": {
"description": "Base64 encoded opaque piece of sensitive information.\n\nScoped to an endpoint of a `Connection` resource.\n",
"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": [
"OPENAI",
"AZUREML",
"AZUREOPENAI",
"BEDROCK",
"SAGEMAKER",
"GOOGLEAI",
"VERTEXAI",
"MONGODB",
"PINECONE",
"ELASTIC"
]
},
"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\n\nThe contents are stored as opaque bytes given in plaintext by an EnvAdmin. \nIn future, we would support more secure methods for distributing authentication tokens.\n",
"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.Statement": {
"type": "object",
"description": "`Statement` represents a core resource used to model SQL statements for execution.\nA statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session\nmanagement or any higher-level functionality.\nThe API allows you to list, create, read, and delete your statements.\n## The Statements Model\n<SchemaDefinition schemaRef=\"#/components/schemas/sql.v1.Statement\" />",
"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",
"STOPPED"
],
"description": "The lifecycle phase of the submitted SQL statement:\n\nPENDING: SQL statement is pending execution;\n\nRUNNING: SQL statement execution is in progress;\n\nCOMPLETED: SQL statement is completed;\n\nDELETING: SQL statement deletion is in progress;\n\nFAILING: SQL statement is failing;\n\nFAILED: SQL statement execution has failed;\n\nSTOPPED: SQL statement execution has successfully been stopped;\n",
"example": "RUNNING",
"readOnly": true
},
"scaling_status": {
"$ref": "#/components/schemas/sql.v1.ScalingStatus"
},
"detail": {
"type": "string",
"description": "Details about the execution status of this statement.",
"example": "Statement is running successfully",
"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:\n\nPUBLIC: SQL statement is using public networking;\n\nPRIVATE: SQL statement is using private networking;\n",
"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\nstring representation of partitions mapped to offsets.\n",
"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": "2023-03-31T00:00:00-00:00",
"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
}
},
"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"
}
},
"readOnly": true
},
"sql.v1.StatementList": {
"type": "object",
"description": "`Statement` represents a core resource used to model SQL statements for execution.\nA statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session\nmanagement or any higher-level functionality.\nThe API allows you to list, create, read, and delete your statements.\n## The Statements Model\n<SchemaDefinition schemaRef=\"#/components/schemas/sql.v1.Statement\" />",
"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", "compute_pool_id"]
}
}
}
]
},
"uniqueItems": true
}
}
},
"sql.v1.StatementResult": {
"type": "object",
"description": "`Statement Result` represents a resource used to model results of SQL statements.\nThe 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.\n\nThe value of `op` attribute (if present) represents the kind of change that a row can describe in a changelog:\n\n`0`: represents `INSERT` (`+I`), i.e. insertion operation;\n\n`1`: represents `UPDATE_BEFORE` (`-U`), i.e. update operation with the previous content of the updated row.\nThis kind should occur together with `UPDATE_AFTER` for modelling an update that needs to retract\nthe previous row first. It is useful in cases of a non-idempotent update, i.e., an update of a row that is not \nuniquely identifiable by a key;\n\n`2`: represents `UPDATE_AFTER` (`+U`), i.e. update operation with new content of the updated row;\nThis kind CAN occur together with `UPDATE_BEFORE` for modelling an update that\nneeds to retract the previous row first or it describes an idempotent update, i.e., an\nupdate of a row that is uniquely identifiable by a key;\n\n`3`: represents `DELETE` (`-D`), i.e. deletion operation;\n\nDefaults to `0`.\n",
"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
},
"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"
},
"maximum": 8192
},
"compute_pool_id": {
"type": "string",
"example": "fcp-00000",
"description": "The id associated with the compute pool in context.",
"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
}
},
"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": "2023-03-31T00:00:00-00:00",
"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.\n\nPENDING_SCALE_DOWN: The statement requires less resources, and will be scaled down in the near future.\n\nPENDING_SCALE_UP: The statement requires more resources, and will be scaled up in the near future.\n\nPOOL_EXHAUSTED: The statement requires more resources, but not enough resources are available.\n",
"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.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)."
}
},
"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"]
},
"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\nthe 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": "2023-03-31T00:00:00-00:00",
"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.\n\nRelated guides:\n* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).\n* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).\n\n\n## The DNS Forwarders Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.DnsForwarder\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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:\n\n PROVISIONING: DNS forwarder provisioning is in progress;\n\n CREATED: DNS forwarder is created. It will automatically become ready once a Kafka cluster is provisioned;\n\n READY: DNS forwarder is ready;\n\n FAILED: DNS forwarder is in a failed state;\n\n DEGRADED: DNS forwarder is in a degraded state, transitioning from 'READY' due to unreachable DNS resolvers;\n\n DEPROVISIONING: DNS forwarder deprovisioning is in progress;\n",
"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.\n\nRelated guides:\n* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).\n* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).\n\n\n## The DNS Forwarders Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.DnsForwarder\" />",
"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.\nThis API allows you to list, create, read, update, and delete your access points.\n\n\n## The Access Points Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.AccessPoint\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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:\n\n PROVISIONING: Access point provisioning is in progress;\n\n PENDING_ACCEPT: Access point connection request is pending acceptance by the customer;\n\n READY: Access point is ready;\n\n FAILED: Access point is in a failed state;\n\n DEPROVISIONING: Access point deprovisioning is in progress;\n\n DISCONNECTED: Access Point has been disconnected in the cloud provider by the customer;\n\n DEGRADED: Access Point is experiencing reduced performance or partial failure;\n\n ERROR: Invalid customer input during Access Point creation;\n",
"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.AzureEgressPrivateLinkEndpointStatus"
},
{
"$ref": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpointStatus"
}
],
"description": "Cloud specific status of the access point.",
"discriminator": {
"propertyName": "kind",
"mapping": {
"AwsEgressPrivateLinkEndpointStatus": "#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpointStatus",
"AzureEgressPrivateLinkEndpointStatus": "#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpointStatus",
"GcpEgressPrivateServiceConnectEndpointStatus": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpointStatus"
}
},
"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.\n\n## The DNS Records Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.DnsRecord\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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:\n\n PROVISIONING: DNS record provisioning is in progress;\n\n CREATED: DNS record is created. It will automatically become ready once a Kafka cluster is provisioned;\n\n READY: DNS record is ready;\n\n FAILED: DNS record is in a failed state;\n\n DEPROVISIONING: DNS record deprovisioning is in progress;\n",
"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.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.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.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.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.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.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
}
}
},
"networking.v1.AccessPointList": {
"type": "object",
"description": "AccessPoint objects represent network connections in and out of Gateways.\nThis API allows you to list, create, read, update, and delete your access points.\n\n\n## The Access Points Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.AccessPoint\" />",
"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.AzureEgressPrivateLinkEndpoint"
},
{
"$ref": "#/components/schemas/networking.v1.AwsPrivateNetworkInterface"
},
{
"$ref": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpoint"
}
],
"discriminator": {
"propertyName": "kind",
"mapping": {
"AwsEgressPrivateLinkEndpoint": "#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpoint",
"AzureEgressPrivateLinkEndpoint": "#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpoint",
"AwsPrivateNetworkInterface": "#/components/schemas/networking.v1.AwsPrivateNetworkInterface",
"GcpEgressPrivateServiceConnectEndpoint": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpoint"
}
},
"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.\n\n## The DNS Records Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.DnsRecord\" />",
"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.\n\nThe API allows you to list, create, read, update, and delete your Certificate Authority.\n",
"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\nstrings 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\neither 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.\n\nThe API allows you to list, create, read, update, and delete your identity pools associated\nwith Certificate Authorities\n\n\nRelated 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).\n\n## The Certificate Identity Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.CertificateIdentityPool\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\npool'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
}
}
},
"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\nused to validate client certs.",
"example": "-----BEGIN CERTIFICATE-----\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n-----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.\nDefaults to this over `crl_url` if available.",
"example": "-----BEGIN X509 CRL-----\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\n-----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\nused to validate client certs.",
"example": "-----BEGIN CERTIFICATE-----\nMIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\nGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\nb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\nBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\nVQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\nDuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\nTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\nKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\nc1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\ngzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\nHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\nAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\nY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\nj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\nhm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\nX4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n-----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.\nDefaults to this over `crl_url` if available.",
"example": "-----BEGIN X509 CRL-----\nMIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD\nVQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1\nZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0\neS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt\nMS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl\nAhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U\nBAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX\nCKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4\nxqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl\ngIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE\njatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6\ncGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg=\n-----END X509 CRL-----"
}
}
},
"iam.v2.CertificateAuthorityList": {
"type": "object",
"description": "`CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your Certificate Authority.\n",
"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.\n\nThe API allows you to list, create, read, update, and delete your identity pools associated\nwith Certificate Authorities\n\n\nRelated 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).\n\n## The Certificate Identity Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.CertificateIdentityPool\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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\nthat may be accessed by Confluent resources (for example, connectors).\n\nThe API allows you to create, retrieve, and delete individual integrations, and also obtain a\nlist of all your provider integrations.\n\n\nRelated guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html).\n\n## The Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/pim.v1.Integration\" />",
"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://.+$",
"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.\n",
"properties": {
"iam_role_arn": {
"type": "string",
"description": "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS)\nIdentity and Access Management (IAM) role that Confluent Cloud uses to assume\ncustomer IAM role when it accesses resources in your AWS account.\n",
"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\nin your Amazon Web Services (AWS) account.\n",
"readOnly": true
},
"customer_iam_role_arn": {
"type": "string",
"description": "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS)\nIdentity and Access Management (IAM) role that Confluent Cloud assumes when\nit accesses resources in your AWS account.\n",
"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\nthat may be accessed by Confluent resources (for example, connectors).\n\nThe API allows you to create, retrieve, and delete individual integrations, and also obtain a\nlist of all your provider integrations.\n\n\nRelated guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html).\n\n## The Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/pim.v1.Integration\" />",
"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
}
}
},
"artifact.v1.FlinkArtifact": {
"type": "object",
"description": "FlinkArtifact objects represent Flink Artifacts on Confluent Cloud.\n\n\n## The Flink Artifacts Model\n<SchemaDefinition schemaRef=\"#/components/schemas/artifact.v1.FlinkArtifact\" />",
"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\nthe URL policy expires in one hour. If the policy expires, you can request\na new presigned upload URL.\n\n\n## The Presigned Urls Model\n<SchemaDefinition schemaRef=\"#/components/schemas/artifact.v1.PresignedUrl\" />",
"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",
"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\n",
"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"
}
],
"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.\n",
"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\nthe URL policy expires in one hour. If the policy expires, you can request\na new presigned upload URL.\n\n\n## The Presigned Urls Model\n<SchemaDefinition schemaRef=\"#/components/schemas/artifact.v1.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": {
"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.\n",
"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.FlinkArtifactList": {
"type": "object",
"description": "FlinkArtifact objects represent Flink Artifacts on Confluent Cloud.\n\n\n## The Flink Artifacts Model\n<SchemaDefinition schemaRef=\"#/components/schemas/artifact.v1.FlinkArtifact\" />",
"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.\n\n\n## The Gateways Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Gateway\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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"
],
"description": "The lifecycle phase of the gateway:\n\n CREATED: gateway exists without an Access Point.\n\n PROVISIONING: gateway provisioning is in progress;\n\n READY: gateway is ready;\n\n FAILED: gateway is in a failed state;\n\n DEPROVISIONING: gateway deprovisioning is in progress;\n",
"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.AwsPrivateNetworkInterfaceGatewayStatus"
},
{
"$ref": "#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewayStatus"
},
{
"$ref": "#/components/schemas/networking.v1.GcpPeeringGatewayStatus"
},
{
"$ref": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewayStatus"
}
],
"readOnly": true,
"discriminator": {
"propertyName": "kind",
"mapping": {
"AwsPrivateNetworkInterfaceGatewayStatus": "#/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewayStatus",
"AwsEgressPrivateLinkGatewayStatus": "#/components/schemas/networking.v1.AwsEgressPrivateLinkGatewayStatus",
"AzureEgressPrivateLinkGatewayStatus": "#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewayStatus",
"GcpPeeringGatewayStatus": "#/components/schemas/networking.v1.GcpPeeringGatewayStatus",
"GcpEgressPrivateServiceConnectGatewayStatus": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewayStatus"
}
}
}
},
"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.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.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.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.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.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.GatewayList": {
"type": "object",
"description": "A Gateway represents a slice of traffic capacity in a region that is reserved for a customer.\n\n\n## The Gateways Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Gateway\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.AwsPeeringGatewaySpec"
},
{
"$ref": "#/components/schemas/networking.v1.AzurePeeringGatewaySpec"
},
{
"$ref": "#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewaySpec"
},
{
"$ref": "#/components/schemas/networking.v1.GcpPeeringGatewaySpec"
},
{
"$ref": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewaySpec"
}
],
"discriminator": {
"propertyName": "kind",
"mapping": {
"AwsPrivateNetworkInterfaceGatewaySpec": "#/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewaySpec",
"AwsPeeringGatewaySpec": "#/components/schemas/networking.v1.AwsPeeringGatewaySpec",
"AwsEgressPrivateLinkGatewaySpec": "#/components/schemas/networking.v1.AwsEgressPrivateLinkGatewaySpec",
"AzurePeeringGatewaySpec": "#/components/schemas/networking.v1.AzurePeeringGatewaySpec",
"AzureEgressPrivateLinkGatewaySpec": "#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewaySpec",
"GcpPeeringGatewaySpec": "#/components/schemas/networking.v1.GcpPeeringGatewaySpec",
"GcpEgressPrivateServiceConnectGatewaySpec": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewaySpec"
}
},
"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.\nThe API allows you to list, create, read, update, and delete your Custom Code Logging.\n\n\n## The Custom Code Loggings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/ccl.v1.CustomCodeLogging\" />",
"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.\n",
"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.\nThe API allows you to list, create, read, update, and delete your Custom Code Logging.\n\n\n## The Custom Code Loggings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/ccl.v1.CustomCodeLogging\" />",
"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.\nThis API allows you to list all supported Tableflow regions.\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.Region\" />",
"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\n\n\n## The Tableflow Topics Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.TableflowTopic\" />",
"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": {
"description": "The status of the Tableflow Topic",
"type": "object",
"properties": {
"phase": {
"type": "string",
"x-extensible-enum": ["PENDING", "RUNNING", "FAILED"],
"description": "The lifecycle phase of the Tableflow:\n\n PENDING: Tableflow setup is pending;\n\n RUNNING: Tableflow is currently running;\n\n FAILED: Tableflow failed\n",
"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
}
},
"readOnly": true
},
"tableflow.v1.CatalogIntegration": {
"type": "object",
"description": "A Catalog Integration represents configuration related to a catalog integration\n\n\n## The Catalog Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.CatalogIntegration\" />",
"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:\n\n PENDING: sync to catalog integration is pending;\n\n CONNECTED: catalog integration is connected and syncing;\n\n FAILED: catalog integration failed.\n",
"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.\n",
"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)\nto retain in the table for the Tableflow-enabled topic (snapshot/version expiration)\n\nThe default value is \"604800000\" milliseconds (equivalent to 7 days).\n\nThe minimum allowed value is \"86400000\" milliseconds (equivalent to 24 hours).\n",
"type": "string",
"format": "int64",
"example": "7776000000"
},
"record_failure_strategy": {
"description": "The strategy to handle record failures in the Tableflow enabled topic during materialization.\n\nFor `SKIP`, we skip the bad records and move to the next record,\n\nand for `SUSPEND`, we suspend the materialization of the topic.\n",
"type": "string",
"x-extensible-enum": ["SUSPEND", "SKIP"],
"default": "SUSPEND"
}
}
},
"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\n",
"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
}
}
},
"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.\n",
"x-immutable": 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.\n",
"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.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.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"
}
],
"discriminator": {
"propertyName": "kind",
"mapping": {
"AwsGlue": "#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec",
"Snowflake": "#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec"
}
}
},
"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.RegionList": {
"type": "object",
"description": "`Region` objects represent cloud provider regions where Tableflow can be enabled.\nThis API allows you to list all supported Tableflow regions.\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.Region\" />",
"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\n\n\n## The Tableflow Topics Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.TableflowTopic\" />",
"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"],
"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"
}
],
"discriminator": {
"propertyName": "kind",
"mapping": {
"ByobAws": "#/components/schemas/tableflow.v1.ByobAwsSpec",
"Managed": "#/components/schemas/tableflow.v1.ManagedStorageSpec"
}
},
"x-immutable": true
},
"table_formats": {
"type": "array",
"description": "The supported table formats for the Tableflow-enabled topic.\n",
"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\n\n\n## The Catalog Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.CatalogIntegration\" />",
"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"
}
],
"discriminator": {
"propertyName": "kind",
"mapping": {
"AwsGlue": "#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueSpec",
"Snowflake": "#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeSpec"
}
}
},
"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
},
"iam.v2.ApiKeySpecUpdate": {
"type": "object",
"description": "The desired state of the Api Key",
"properties": {
"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"
}
},
"x-enable-id": true,
"x-enable-listmeta": true,
"x-enable-objectmeta": true
},
"iam.v2.ApiKeyUpdate": {
"type": "object",
"description": "`ApiKey` objects represent access to different parts of Confluent Cloud. Some types\nof API keys represent access to a single cluster/resource such as a Kafka cluster,\nSchema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization\nthat are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API.\nTableflow API keys are not tied to a specific cluster.\n\nThe API allows you to list, create, update and delete your API Keys.\n\n\nRelated guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html).\n\n## The API Keys Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.ApiKey\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.ApiKeySpecUpdate"
}
}
},
"iam.v2.UserUpdate": {
"type": "object",
"description": "`User` objects represent individuals who may access your Confluent resources.\n\nThe API allows you to retrieve, update, and delete individual users, as well as list of all your\nusers. This API cannot be used to create new user accounts.\n\n\nRelated guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html).\n\n## The Users Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.User\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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"
}
}
}
]
},
"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
}
}
},
"notifications.v1.SubscriptionUpdate": {
"type": "object",
"description": "`Subscription` objects represent the intent of the customers to get notifications of particular types.\nA subscription is created for a particular `NotificationType` and the user will get notifications on the\n`Integrations` that are provided while creating the subscription.\n\nThis API allows you to create, retrieve, and update subscriptions,\nas well as to view the list of all your subscriptions. You can also delete subscriptions\nwith RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Subscriptions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.Subscription\" />",
"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\nnotification on the configured Integrations. If the subscription is DISABLED, the user will not\nrecieve any notification for the configured notification type. Note that, you cannot disable\na subscription for `REQUIRED` notification type.\n",
"example": "ENABLED"
},
"integrations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalObjectReference"
},
"description": "Integrations to which notifications are to be sent.",
"minItems": 1
}
}
},
"cmk.v2.ClusterSpecUpdate": {
"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\n",
"x-extensible-enum": ["MULTI_ZONE", "SINGLE_ZONE", "HIGH", "LOW"],
"example": "SINGLE_ZONE"
},
"config": {
"description": "The configuration of the Kafka cluster.\n\nNote: Clusters can be upgraded from Basic to Standard, but cannot be downgraded from Standard to Basic.\n",
"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"
}
]
},
"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
},
"cmk.v2.ClusterUpdate": {
"type": "object",
"description": "`Clusters` objects represent Apache Kafka Clusters on Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your Kafka clusters.\n\n\nRelated guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cmk.v2.Cluster\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.ClusterSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/cmk.v2.ClusterStatus"
}
}
},
"connect.v1.CustomConnectorPluginUpdate": {
"type": "object",
"description": "CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud.\nThe API allows you to list, create, read, update, and delete your Custom Connector Plugins.\nRelated guide:\n[Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html).\n\n\n## The Custom Connector Plugins Model\n<SchemaDefinition schemaRef=\"#/components/schemas/connect.v1.CustomConnectorPlugin\" />",
"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."
},
"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",
"oneOf": [
{
"$ref": "#/components/schemas/connect.v1.UploadSource.PresignedUrl"
}
],
"description": "[immutable] 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"
}
}
}
}
},
"srcm.v2.ClusterSpecUpdate": {
"type": "object",
"description": "The desired state of the Cluster",
"properties": {
"package": {
"type": "string",
"description": "The billing package.\n\nNote: Clusters can be upgraded from ESSENTIALS to ADVANCED, but cannot be\ndowngraded from ADVANCED to ESSENTIALS.\n",
"x-extensible-enum": ["ESSENTIALS", "ADVANCED"],
"example": "ESSENTIALS"
},
"environment": {
"allOf": [
{
"$ref": "#/components/schemas/GlobalObjectReference"
}
],
"description": "The environment to which this belongs."
}
},
"x-enable-id": true,
"x-enable-listmeta": true,
"x-enable-objectmeta": true
},
"srcm.v2.ClusterUpdate": {
"type": "object",
"description": "`Clusters` objects represent Schema Registry Clusters on Confluent Cloud.\n\nThe API allows you to list, create, read, and delete your Schema Registry clusters.\n\n\nRelated guides:\n* [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management).\n* [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).\n\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v2.Cluster\" />",
"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.ClusterSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/srcm.v2.ClusterStatus"
}
}
},
"cdx.v1.ProviderSharedResourceUpdate": {
"type": "object",
"description": "`ProviderSharedResource` object contains details of the data stream\n(topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing.\n\n\n## The Provider Shared Resources Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />",
"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"
}
}
}
]
},
"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"
},
"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
}
}
},
"networking.v1.NetworkSpecUpdate": {
"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"
},
"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.NetworkUpdate": {
"type": "object",
"description": "`Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud\nprovider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters.\nShared networks can contain any cluster type.\n\nThe API allows you to list, create, read, update, and delete your networks.\n\n\nRelated guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html).\n\n## The Networks Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Network\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.NetworkSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.NetworkStatus"
}
}
},
"networking.v1.PeeringSpecUpdate": {
"type": "object",
"description": "The desired state of the Peering",
"properties": {
"display_name": {
"type": "string",
"description": "The name of the peering",
"example": "prod-peering-use1"
},
"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.PeeringUpdate": {
"type": "object",
"description": "Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud.\n\nRelated guides:\n* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).\n* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).\n* [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html).\n\n\n## The Peerings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Peering\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.PeeringSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.PeeringStatus"
}
}
},
"networking.v1.TransitGatewayAttachmentSpecUpdate": {
"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"
},
"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.TransitGatewayAttachmentUpdate": {
"type": "object",
"description": "AWS Transit Gateway Attachments\n\nRelated guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html).\n\n## The Transit Gateway Attachments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.TransitGatewayAttachment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.TransitGatewayAttachmentSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.TransitGatewayAttachmentStatus"
}
}
},
"networking.v1.PrivateLinkAccessSpecUpdate": {
"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"
},
"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.PrivateLinkAccessUpdate": {
"type": "object",
"description": "Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID.\n\nRelated guides:\n* [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html).\n* [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html).\n* [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).\n\n\n## The Private Link Accesses Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAccess\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `private_link_accounts_per_network` | Number of AWS accounts per network |\n| `private_link_subscriptions_per_network` | Number of Azure subscriptions per network |\n| `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.PrivateLinkAccessSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.PrivateLinkAccessStatus"
}
}
},
"networking.v1.NetworkLinkServiceSpecUpdate": {
"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."
}
},
"x-enable-id": true,
"x-enable-listmeta": true,
"x-enable-objectmeta": true
},
"networking.v1.NetworkLinkServiceUpdate": {
"type": "object",
"description": "Network Link Service is associated with a Private Link Confluent Cloud Network.\nIt enables connectivity from other Private Link Confluent Cloud Networks based on\nthe configured accept policies.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Services Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkService\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.NetworkLinkServiceSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.NetworkLinkServiceStatus"
}
}
},
"networking.v1.NetworkLinkEndpointSpecUpdate": {
"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."
}
},
"x-enable-id": true,
"x-enable-listmeta": true,
"x-enable-objectmeta": true
},
"networking.v1.NetworkLinkEndpointUpdate": {
"type": "object",
"description": "A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a\nNetwork Link Service (associated with another Private Link Confluent Cloud Network) at the target.\nIt enables connectivity between the origin network and the target network.\nIt can only be associated with a Private Link network.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Endpoints Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkEndpoint\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.NetworkLinkEndpointSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.NetworkLinkEndpointStatus"
}
}
},
"networking.v1.PrivateLinkAttachmentSpecUpdate": {
"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"
},
"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.PrivateLinkAttachmentUpdate": {
"type": "object",
"description": "PrivateLink attachment objects represent reservations to establish PrivateLink connections\nto a cloud region in order to access resources that belong to a Confluent Cloud Environment.\nThe API allows you to list, create, read update and delete your PrivateLink attachments.\n\n\n## The Private Link Attachments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAttachment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.PrivateLinkAttachmentSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.PrivateLinkAttachmentStatus"
}
}
},
"networking.v1.PrivateLinkAttachmentConnectionSpecUpdate": {
"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"
},
"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.PrivateLinkAttachmentConnectionUpdate": {
"type": "object",
"description": "PrivateLink attachment connection objects represent connections established to a cloud region\nin order to access resources that belong to a Confluent Cloud Environment.\nThe API allows you to list, create, read update and delete your PrivateLink attachment connections.\n\n\n## The Private Link Attachment Connections Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAttachmentConnection\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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.PrivateLinkAttachmentConnectionSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus"
}
}
},
"kafka-quotas.v1.ClientQuotaSpecUpdate": {
"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"
}
]
},
"principals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalObjectReference"
},
"description": "A list of principals to apply a client quota to.\nUse `\"<default>\"` to apply a client quota to all service accounts\n(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).\n",
"minItems": 1
}
},
"x-enable-id": true,
"x-enable-listmeta": true,
"x-enable-objectmeta": true
},
"kafka-quotas.v1.ClientQuotaUpdate": {
"type": "object",
"description": "`ClientQuota` objects represent Client Quotas you can set at the service account level.\n\nThe API allows you to list, create, read, update, and delete your client quotas.\n\n\nRelated guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html).\n\n## The Client Quotas Model\n<SchemaDefinition schemaRef=\"#/components/schemas/kafka-quotas.v1.ClientQuota\" />",
"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.ClientQuotaSpecUpdate"
}
}
},
"fcpm.v2.ComputePoolSpecUpdate": {
"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
},
"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.\n",
"x-extensible-enum": [5, 10, 20, 30, 40, 50],
"x-immutable": false
},
"environment": {
"allOf": [
{
"$ref": "#/components/schemas/GlobalObjectReference"
}
],
"description": "The environment to which this belongs."
}
},
"x-enable-id": true,
"x-enable-listmeta": true,
"x-enable-objectmeta": true
},
"fcpm.v2.ComputePoolUpdate": {
"type": "object",
"description": "A Compute Pool represents a set of compute resources that is used to run your Queries.\nThe resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it.\nNote that the Compute Pool API supports a limited pagination API, only the `next` field will be populated.\n\n\n## The Compute Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/fcpm.v2.ComputePool\" />",
"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.ComputePoolSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/fcpm.v2.ComputePoolStatus"
}
}
},
"networking.v1.DnsForwarderSpecUpdate": {
"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."
}
},
"x-enable-id": true,
"x-enable-listmeta": true,
"x-enable-objectmeta": true
},
"networking.v1.DnsForwarderUpdate": {
"type": "object",
"description": "Add, remove, and update DNS forwarder for your gateway.\n\nRelated guides:\n* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).\n* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).\n\n\n## The DNS Forwarders Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.DnsForwarder\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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.DnsForwarderSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.DnsForwarderStatus"
}
}
},
"networking.v1.AccessPointSpecUpdate": {
"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.AzureEgressPrivateLinkEndpoint"
},
{
"$ref": "#/components/schemas/networking.v1.AwsPrivateNetworkInterface"
},
{
"$ref": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpoint"
}
],
"discriminator": {
"propertyName": "kind",
"mapping": {
"AwsEgressPrivateLinkEndpoint": "#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpoint",
"AzureEgressPrivateLinkEndpoint": "#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpoint",
"AwsPrivateNetworkInterface": "#/components/schemas/networking.v1.AwsPrivateNetworkInterface",
"GcpEgressPrivateServiceConnectEndpoint": "#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpoint"
}
},
"description": "The specific details of the different access point configurations."
},
"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.AccessPointUpdate": {
"type": "object",
"description": "AccessPoint objects represent network connections in and out of Gateways.\nThis API allows you to list, create, read, update, and delete your access points.\n\n\n## The Access Points Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.AccessPoint\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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.AccessPointSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.AccessPointStatus"
}
}
},
"networking.v1.DnsRecordSpecUpdate": {
"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"
},
"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."
}
},
"x-enable-id": true,
"x-enable-listmeta": true,
"x-enable-objectmeta": true
},
"networking.v1.DnsRecordUpdate": {
"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.\n\n## The DNS Records Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.DnsRecord\" />",
"properties": {
"api_version": {
"type": "string",
"enum": ["networking/v1"],
"description": "APIVersion defines the schema 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.DnsRecordSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.DnsRecordStatus"
}
}
},
"artifact.v1.FlinkArtifactUpdate": {
"type": "object",
"description": "FlinkArtifact objects represent Flink Artifacts on Confluent Cloud.\n\n\n## The Flink Artifacts Model\n<SchemaDefinition schemaRef=\"#/components/schemas/artifact.v1.FlinkArtifact\" />",
"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
},
"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"
}
}
}
},
"networking.v1.GatewaySpecUpdate": {
"type": "object",
"description": "The desired state of the Gateway",
"properties": {
"display_name": {
"type": "string",
"description": "The name of the gateway.",
"example": "prod-gateway"
},
"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.GatewayUpdate": {
"type": "object",
"description": "A Gateway represents a slice of traffic capacity in a region that is reserved for a customer.\n\n\n## The Gateways Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Gateway\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `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.GatewaySpecUpdate"
},
"status": {
"$ref": "#/components/schemas/networking.v1.GatewayStatus"
}
}
},
"ccl.v1.CustomCodeLoggingUpdate": {
"type": "object",
"description": "CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud.\nThe API allows you to list, create, read, update, and delete your Custom Code Logging.\n\n\n## The Custom Code Loggings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/ccl.v1.CustomCodeLogging\" />",
"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"
}
}
}
]
},
"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."
}
}
},
"tableflow.v1.TableflowTopicSpecUpdate": {
"type": "object",
"description": "The desired state of the Tableflow Topic",
"properties": {
"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"
}
]
},
"table_formats": {
"type": "array",
"description": "The supported table formats for the Tableflow-enabled topic.\n",
"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.TableflowTopicUpdate": {
"type": "object",
"description": "A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic\n\n\n## The Tableflow Topics Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.TableflowTopic\" />",
"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.TableflowTopicSpecUpdate"
},
"status": {
"$ref": "#/components/schemas/tableflow.v1.TableflowTopicStatus"
}
}
}
},
"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://<oauth-identity-provider>/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"
}
}
]
}
}
}
},
"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": null
}
}
}
},
"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"
}
}
}
}
},
"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": null
},
"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": null
},
"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": null
},
"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": 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"
}
]
}
]
}
}
}
},
"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": null
},
"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": null
},
"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": 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"
}
}
]
}
}
}
},
"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
}
]
}
}
}
},
"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"
}
}
]
}
}
}
},
"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"
}
}
]
}
}
}
},
"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": null
},
"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"
}
}
]
}
}
}
},
"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"
}
]
}
]
}
}
}
},
"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"
}
}
]
}
}
}
},
"ProduceResponse": {
"description": "The response containing a delivery report for a record produced to a topic. In streaming mode,\nfor each record sent, a separate delivery report will be returned, in the same order,\neach 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": null
},
"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": null
},
"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"
}
}
]
}
}
}
},
"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": "<html> <head> <meta http-equiv=\"Content-Type\" content=\"text/html;charset=utf-8\"/> <title>Error 429 Too Many Requests</title> </head> <body> <h2>HTTP ERROR 429 Too Many Requests</h2> <table> <tr> <th>URI:</th> <td>/v3/clusters/my-cluster</td> </tr> <tr> <th>STATUS:</th> <td>429</td> </tr> <tr> <th>MESSAGE:</th> <td>Too Many Requests</td> </tr> <tr> <th>SERVLET:</th> <td>default</td> </tr> </table> </body> </html>"
}
}
}
},
"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": null
},
"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": null
},
"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": null
},
"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": null
},
"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": null
},
"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": null
},
"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": null
},
"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": null
},
"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": null,
"error_message": null,
"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": null,
"error_message": null,
"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": null
},
"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": null,
"error_message": null,
"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": null,
"error_message": null,
"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": null
},
"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": null,
"error_message": null,
"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": null
},
"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": 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"
}
]
}
}
}
},
"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",
"default": false,
"read_only": false,
"sensitive": false,
"source": "DYNAMIC_CLUSTER_LINK_CONFIG",
"synonyms": ["cosm"],
"link_name": "link-db-1",
"link_id": "7840644d-f7d8-4844-a577-a10ef3df31df"
},
{
"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",
"default": false,
"read_only": false,
"sensitive": false,
"source": "DYNAMIC_CLUSTER_LINK_CONFIG",
"synonyms": ["asm"],
"link_name": "link-db-1",
"link_id": "7840644d-f7d8-4844-a577-a10ef3df31df"
}
]
}
}
}
},
"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",
"default": false,
"read_only": false,
"sensitive": false,
"source": "DYNAMIC_CLUSTER_LINK_CONFIG",
"synonyms": ["cosm"],
"link_name": "link-db-1",
"link_id": "7840644d-f7d8-4844-a577-a10ef3df31df",
"topics": ["topic-db-1", "topic-db-2"]
}
}
}
},
"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
}
]
}
]
}
}
}
},
"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.",
"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"
},
"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": {
"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"
}
}
}
},
"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='<Kafka API Key>' password='<Kafka API Secret>';"
}
]
}
},
"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='<Kafka API Key>' password='<Kafka API Secret>';"
}
]
}
},
"source_initiated_link_at_destination_cluster": {
"description": "Create a source initiated cluster link at destination cluster",
"value": {
"destination_cluster_id": "cluster-1",
"configs": [
{
"name": "bootstrap.servers",
"value": "cluster-1-bootstrap-server"
},
{
"name": "link.mode",
"value": "DESTINATION"
},
{
"name": "connection.mode",
"value": "INBOUND"
},
{
"name": "acl.sync.enable",
"value": "false"
},
{
"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='<Kafka API Key>' password='<Kafka API Secret>';"
}
]
}
},
"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='<Kafka API Key>' password='<Kafka API Secret>';"
}
]
}
},
"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='<Kafka API Key>' password='<Kafka API Secret>';"
}
]
}
}
}
}
}
},
"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": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`ApiKey` objects represent access to different parts of Confluent Cloud. Some types\nof API keys represent access to a single cluster/resource such as a Kafka cluster,\nSchema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization\nthat are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API.\nTableflow API keys are not tied to a specific cluster.\n\nThe API allows you to list, create, update and delete your API Keys.\n\n\nRelated guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html).\n\n## The API Keys Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.ApiKey\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `apikeys_per_org` | API Keys in one Confluent Cloud organization |"
},
{
"name": "Environments (org/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Environment` objects represent an isolated namespace for your Confluent resources\nfor organizational purposes.\n\nThe API allows you to create, delete, and update your environments. You can retrieve\nindividual environments as well as a list of all your environments.\n\n\nRelated guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html).\n\n## The Environments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/org.v2.Environment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `environments_per_org` | Environments in one Confluent Cloud organization |"
},
{
"name": "Organizations (org/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Organization` objects represent a customer organization. An organization contains all customer\nresources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing\nagreement (including any annual commitment or support plan).\n\nThe API allows you to list, view, and update your organizations.\n\n\nRelated guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html).\n\n## The Organizations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/org.v2.Organization\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `organizations_per_user` | Confluent Cloud organizations a user belongs to |"
},
{
"name": "Users (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`User` objects represent individuals who may access your Confluent resources.\n\nThe API allows you to retrieve, update, and delete individual users, as well as list of all your\nusers. This API cannot be used to create new user accounts.\n\n\nRelated guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html).\n\n## The Users Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.User\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `users_per_org` | Users in one Confluent Cloud organization |"
},
{
"name": "Service Accounts (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`ServiceAccount` objects are typically used to represent applications and other non-human principals\nthat may access your Confluent resources.\n\nThe API allows you to create, retrieve, update, and delete individual service accounts, as well as\nlist all your service accounts.\n\n\nRelated guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html).\n\n## The Service Accounts Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.ServiceAccount\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization |"
},
{
"name": "Invitations (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud.\n\nThe API allows you to list all your invitations, as well as create, read, and delete a specified invitation.\n\n\nRelated guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html).\n\n## The Invitations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.Invitation\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `invitations_per_org` | Invitations in a Confluent Cloud organization |"
},
{
"name": "IP Groups (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDefinitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules.\n\n\n## The IP Groups Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IpGroup\" />"
},
{
"name": "IP Filters (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`IP Filter` objects are bindings between IP Groups and Confluent resource(s).\nFor example, a binding between \"CorpNet\" and \"Management APIs\" will enforce that\naccess must come from one of the CIDR blocks associated with CorpNet.\nIf there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks\nfor any of the IP Group will allow the request.\nIf there are no IP Filters for a resource, then access will be granted to requests originating\nfrom any IP Address.\n\n\n## The IP Filters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IpFilter\" />"
},
{
"name": "IP Filter Summaries (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe IP Filter Summary endpoint returns an aggregation of the IP Filters across the system.\nThis API can be queried in the context of an organization or an environment. It returns a\nsummary of every operation group in the system grouped with a higher summary by operation\ngroup category.\n\n\n## The IP Filter Summaries Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IpFilterSummary\" />"
},
{
"name": "Role Bindings (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nA role binding grants a Principal a role on resources that match a pattern.\n\nThe API allows you to perform create, delete, and list operations on role bindings.\n\n\nRelated guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html).\n\n## The Role Bindings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.RoleBinding\" />"
},
{
"name": "Subscriptions (notifications/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Subscription` objects represent the intent of the customers to get notifications of particular types.\nA subscription is created for a particular `NotificationType` and the user will get notifications on the\n`Integrations` that are provided while creating the subscription.\n\nThis API allows you to create, retrieve, and update subscriptions,\nas well as to view the list of all your subscriptions. You can also delete subscriptions\nwith RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Subscriptions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.Subscription\" />"
},
{
"name": "Integrations (notifications/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nYou can create an `Integration` to specify how we can notify you when we receive an alert/notification for\na subscription. Please note that you can only perform create, update and delete operations for integrations\nof type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail`\nand `UserEmail`.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.Integration\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization |"
},
{
"name": "Notification Types (notifications/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe type of notifications (and their corresponding metadata) supported by Confluent.\n\n\nRelated guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).\n\n## The Notification Types Model\n<SchemaDefinition schemaRef=\"#/components/schemas/notifications.v1.NotificationType\" />"
},
{
"name": "Clusters (cmk/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Clusters` objects represent Apache Kafka Clusters on Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your Kafka clusters.\n\n\nRelated guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cmk.v2.Cluster\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment |"
},
{
"name": "Clusters (ksqldbcm/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint.\nIt executes SQL statements and queries which under the hood get built into corresponding\nKafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters.\n\n\nRelated guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/ksqldbcm.v2.Cluster\" />\n\n## Quotas and Limits\nThis resource is subject to the following quotas:\n\n| Quota | Description |\n| --- | --- |\n| `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. |"
},
{
"name": "Connectors (connect/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAPI for Managed Connectors or Custom Connectors in Confluent Cloud.\n\nThe API allows you to list, create, get, update and delete a Managed Connector or Custom Connector in Confluent Cloud.\n\nConnect metrics are available through the [Metrics v2 API](https://api.telemetry.confluent.cloud/docs#tag/Version-2).\n\nRelated guide: [Confluent Cloud API and Managed Connectors](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html)."
},
{
"name": "Lifecycle (connect/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAPI 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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAPI for requesting the status or the tasks for a Managed Connector or Custom Connector in Confluent Cloud."
},
{
"name": "Managed Connector Plugins (connect/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAPI for Managed connectors in Confluent Cloud."
},
{
"name": "Offsets (connect/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAPI for managing the offsets for a Managed Connector.\n\nRelated 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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nCustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud.\nThe API allows you to list, create, read, update, and delete your Custom Connector Plugins.\nRelated guide:\n[Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html).\n\n\n## The Custom Connector Plugins Model\n<SchemaDefinition schemaRef=\"#/components/schemas/connect.v1.CustomConnectorPlugin\" />"
},
{
"name": "Presigned Urls (connect/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRequest a presigned upload URL for new Custom Connector Plugin. Note that\nthe URL policy expires in one hour. If the policy expires, you can request\na new presigned upload URL.\n\nRelated guide:\n[Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html).\n\n\n## The Presigned Urls Model\n<SchemaDefinition schemaRef=\"#/components/schemas/connect.v1.PresignedUrl\" />"
},
{
"name": "Cluster (v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)"
},
{
"name": "Configs (v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)"
},
{
"name": "ACL (v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)"
},
{
"name": "Consumer Group (v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)"
},
{
"name": "Partition (v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)"
},
{
"name": "Topic (v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)"
},
{
"name": "Records (v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)"
},
{
"name": "Cluster Linking (v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)"
},
{
"name": "Applied Quotas (service-quota/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nA `quota` object represents a quota configuration for a specific Confluent Cloud resource.\nUse this API to retrieve an individual quota or list of quotas for a given scope.\n\n\nRelated guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html).\n\n## The Applied Quotas Model\n<SchemaDefinition schemaRef=\"#/components/schemas/service-quota.v1.AppliedQuota\" />"
},
{
"name": "Scopes (service-quota/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nGets a list of all available scopes for applied quotas.\n\n\nRelated guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes).\n\n## The Scopes Model\n<SchemaDefinition schemaRef=\"#/components/schemas/service-quota.v1.Scope\" />"
},
{
"name": "Entitlements (partner/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\n`Entitlement` objects represent metadata about a marketplace entitlement.\n\nAn entitlement includes metadata about a marketplace purchase\n(start date, end date, billing information, partner IDs, etc).\nThe API allows partners to create, read, and list entitlements. (Unless you\nneed entitlement creation and customer registration to be separate,\nwe recommend using the Signup API to create an organization and entitlement\nat the same time)\n\nThe API only allows authorized partners to interact with the Entitlements API.\n"
},
{
"name": "Regions (srcm/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Region` objects represent cloud provider regions available when placing Schema Registry clusters.\nThe API allows you to list Schema Registry regions.\n\n\nRelated guides:\n* [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support).\n* [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).\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v2.Region\" />"
},
{
"name": "Clusters (srcm/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Clusters` objects represent Schema Registry Clusters on Confluent Cloud.\n\nThe API allows you to list, create, read, and delete your Schema Registry clusters.\n\n\nRelated guides:\n* [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management).\n* [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).\n\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v2.Cluster\" />"
},
{
"name": "Clusters (srcm/v3)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Clusters` objects represent Schema Registry Clusters on Confluent Cloud.\n\nThe API allows you to list and read your Schema Registry clusters.\n\n\nRelated guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management).\n\n## The Clusters Model\n<SchemaDefinition schemaRef=\"#/components/schemas/srcm.v3.Cluster\" />"
},
{
"name": "Compatibility (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to test schema compatibility.\n\nRelated guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud)."
},
{
"name": "Config (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to manage and query schema compatibility settings and cluster configurations.\n\nRelated guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud)."
},
{
"name": "Contexts (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to retrieve information about schema contexts.\n\nRelated guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud)."
},
{
"name": "Exporters (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to create, retrieve, update, and delete exporters.\n\nRelated guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud)."
},
{
"name": "Modes (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to create, retrieve, update, and delete schema subjects modes of operation.\n\nRelated guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud)."
},
{
"name": "Schemas (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to create, retrieve, update, and delete schemas.\n\nRelated guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud)."
},
{
"name": "Subjects (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to create, retrieve, update, and delete schema subjects and versions.\n\nRelated 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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to create, retrieve, update, and delete key encryption keys.\n\nRelated 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": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to create, retrieve, update, and delete data encryption keys.\n\nRelated guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud)."
},
{
"name": "Entity (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to create, retrieve, update, and delete catalog entities.\n\nRelated guide: [Catalog API Documentation](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html#catalog-api-documentation)."
},
{
"name": "Search (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to search for entities.\n\nRelated guide: [Catalog API Documentation](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html#catalog-api-documentation)."
},
{
"name": "Types (v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nThe API allows you to create, retrieve, update, and delete catalog types such as tag definitions.\n\nRelated 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": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`ProviderSharedResource` object contains details of the data stream\n(topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing.\n\n\n## The Provider Shared Resources Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />"
},
{
"name": "Provider Shares (cdx/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`ProviderShare` object respresents the share that you have created through Stream Sharing.\n\n\nRelated guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares).\n\n## The Provider Shares Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderShare\" />"
},
{
"name": "Consumer Shared Resources (cdx/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`ConsumerSharedResource` object contains details of the data stream\n(topic, schema registry subjects, sharing metadata) that you received through Stream Sharing.\n\n\n## The Consumer Shared Resources Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerSharedResource\" />"
},
{
"name": "Consumer Shares (cdx/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`ConsumerShare` object respresents the share that you received through Stream Sharing.\n\n\nRelated guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html).\n\n## The Consumer Shares Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerShare\" />"
},
{
"name": "Shared Tokens (cdx/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nEncrypted Token shared with consumer\n\n\n## The Shared Tokens Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.SharedToken\" />"
},
{
"name": "Opt Ins (cdx/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nStream sharing opt in options\n\n## The Opt Ins Model\n<SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.OptIn\" />"
},
{
"name": "Organizations (partner/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\n`Organizations` objects represent an entire Confluent Cloud organization.\nPartners are allowed to get an organization they have signed up or\nlist all organizations they have signed up.\n"
},
{
"name": "Signup (partner/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\n`Signup` APIs can only be performed by partners.\n"
},
{
"name": "Networks (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud\nprovider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters.\nShared networks can contain any cluster type.\n\nThe API allows you to list, create, read, update, and delete your networks.\n\n\nRelated guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html).\n\n## The Networks Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Network\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment |"
},
{
"name": "Peerings (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAdd or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud.\n\nRelated guides:\n* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).\n* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).\n* [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html).\n\n\n## The Peerings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Peering\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `peerings_per_network` | Number of peerings per network |"
},
{
"name": "Transit Gateway Attachments (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAWS Transit Gateway Attachments\n\nRelated guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html).\n\n## The Transit Gateway Attachments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.TransitGatewayAttachment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `tgw_attachments_per_network` | Number of TGW attachments per network |"
},
{
"name": "Private Link Accesses (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAdd or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID.\n\nRelated guides:\n* [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html).\n* [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html).\n* [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).\n\n\n## The Private Link Accesses Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAccess\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `private_link_accounts_per_network` | Number of AWS accounts per network |\n| `private_link_subscriptions_per_network` | Number of Azure subscriptions per network |\n| `private_service_connect_projects_per_network` | Number of GCP projects per network |"
},
{
"name": "Network Link Services (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nNetwork Link Service is associated with a Private Link Confluent Cloud Network.\nIt enables connectivity from other Private Link Confluent Cloud Networks based on\nthe configured accept policies.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Services Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkService\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `network_link_service_per_network` | Number of network link services per network |"
},
{
"name": "Network Link Endpoints (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nA Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a\nNetwork Link Service (associated with another Private Link Confluent Cloud Network) at the target.\nIt enables connectivity between the origin network and the target network.\nIt can only be associated with a Private Link network.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Endpoints Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkEndpoint\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `network_link_endpoints_per_network` | Number of network link endpoints per network |"
},
{
"name": "Network Link Service Associations (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nList of incoming Network Link Enpoints associated with the Network Link Service.\n\n\nRelated guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).\n\n## The Network Link Service Associations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.NetworkLinkServiceAssociation\" />"
},
{
"name": "IP Addresses (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nIP Addresses\n\nRelated guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html)\n\n## The IP Addresses Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.IpAddress\" />"
},
{
"name": "Private Link Attachments (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nPrivateLink attachment objects represent reservations to establish PrivateLink connections\nto a cloud region in order to access resources that belong to a Confluent Cloud Environment.\nThe API allows you to list, create, read update and delete your PrivateLink attachments.\n\n\n## The Private Link Attachments Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAttachment\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment |"
},
{
"name": "Private Link Attachment Connections (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nPrivateLink attachment connection objects represent connections established to a cloud region\nin order to access resources that belong to a Confluent Cloud Environment.\nThe API allows you to list, create, read update and delete your PrivateLink attachment connections.\n\n\n## The Private Link Attachment Connections Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.PrivateLinkAttachmentConnection\" />"
},
{
"name": "Identity Providers (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your Identity Provider.\n\n\nRelated guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html).\n\n## The Identity Providers Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IdentityProvider\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `identity_providers_per_org` | Number of OAuth identity providers per organization |\n| `public_keys_per_provider` | Number of public keys saved per identity provider |"
},
{
"name": "Jwks (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`JWKS` objects represent public key sets for a specific OAuth/OpenID Connect provider within\nConfluent Cloud.\n\nThe API allows you to refresh JWKS public key data.\n\n\nRelated guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html).\n\n## The Jwks Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.Jwks\" />"
},
{
"name": "Identity Pools (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider`\nthat authorizes them to Confluent Cloud resources.\n\nIt provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that\nis then used to provide access to Confluent Resources.\n\n\nRelated guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html).\n\n## The Identity Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.IdentityPool\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `identity_pools_per_provider` | Number of Identity Pools per Identity Provider |"
},
{
"name": "OAuth Tokens (sts/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nOAuth Token is a [JSON Web Token (JWT)](https://www.rfc-editor.org/rfc/rfc7519) that enables the use of\nexternal identities to access Confluent Cloud APIs\n"
},
{
"name": "Client Quotas (kafka-quotas/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`ClientQuota` objects represent Client Quotas you can set at the service account level.\n\nThe API allows you to list, create, read, update, and delete your client quotas.\n\n\nRelated guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html).\n\n## The Client Quotas Model\n<SchemaDefinition schemaRef=\"#/components/schemas/kafka-quotas.v1.ClientQuota\" />"
},
{
"name": "Keys (byok/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Key` objects represent customer managed keys on dedicated Confluent Cloud clusters.\n\nKeys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP.\nThis API allows you to upload and retrieve self-managed keys on Confluent Cloud.\n\n\nRelated guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html).\n\n## The Keys Model\n<SchemaDefinition schemaRef=\"#/components/schemas/byok.v1.Key\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. |"
},
{
"name": "Costs (billing/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Cost` objects represent the aggregated billing costs for an organization\n\n\nRelated guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates).\n\n## The Costs Model\n<SchemaDefinition schemaRef=\"#/components/schemas/billing.v1.Cost\" />"
},
{
"name": "Group Mappings (iam/v2/sso)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`GroupMapping` objects establish relationships between user groups in your SSO\nidentity provider and specific RBAC roles in Confluent Cloud.\n\nGroup mappings enable automated and secure access control to Confluent Cloud resources,\nreducing administrative workload by streamlining user provisioning and authorization.\n\n\nRelated guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html).\n\n## The Group Mappings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.sso.GroupMapping\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `group_mappings_per_org` | Number of group mappings per organization |"
},
{
"name": "Compute Pools (fcpm/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nA Compute Pool represents a set of compute resources that is used to run your Queries.\nThe resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it.\nNote that the Compute Pool API supports a limited pagination API, only the `next` field will be populated.\n\n\n## The Compute Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/fcpm.v2.ComputePool\" />"
},
{
"name": "Regions (fcpm/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Region` objects represent cloud provider regions available when placing Flink compute pools.\nThe API allows you to list Flink regions.\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/fcpm.v2.Region\" />"
},
{
"name": "Statements (sql/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Statement` represents a core resource used to model SQL statements for execution.\nA statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session\nmanagement or any higher-level functionality.\nThe API allows you to list, create, read, and delete your statements.\n## The Statements Model\n<SchemaDefinition schemaRef=\"#/components/schemas/sql.v1.Statement\" />"
},
{
"name": "Statement Results (sql/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`StatementResult` represents a result of a `Statement` resource.\nThe API allows you to read your statement's results.\n## The Statement Results Model\n<SchemaDefinition schemaRef=\"#/components/schemas/sql.v1.StatementResult\" />"
},
{
"name": "Statement Exceptions (sql/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`StatementException` represents an exception of a `Statement` resource.\nThe API allows you to read your statement's exceptions.\n## The Statement Exceptions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/sql.v1.StatementException\" />"
},
{
"name": "Connections (sql/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Connection` represents a core resource used to model SQL connections for execution.\nA connection generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session\nmanagement or any higher-level functionality.\nThe API allows you to list, create, read, and delete your connections.\n## The Connections Model\n<SchemaDefinition schemaRef=\"#/components/schemas/sql.v1.Connection\" />"
},
{
"name": "DNS Forwarders (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAdd, remove, and update DNS forwarder for your gateway.\n\nRelated guides:\n* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).\n* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).\n\n\n## The DNS Forwarders Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.DnsForwarder\" />"
},
{
"name": "Access Points (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nAccessPoint objects represent network connections in and out of Gateways.\nThis API allows you to list, create, read, update, and delete your access points.\n\n\n## The Access Points Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.AccessPoint\" />"
},
{
"name": "DNS Records (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nDNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records.\n\n## The DNS Records Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.DnsRecord\" />"
},
{
"name": "Certificate Authorities (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your Certificate Authority.\n\n\nRelated guide: [Manage certificate authorities used for client authentication with X.509 certificates.](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/overview.html).\n\n## The Certificate Authorities Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.CertificateAuthority\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `certificate_authorities_per_org` | Number of certificate authorities per organization |"
},
{
"name": "Certificate Identity Pools (iam/v2)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Identitypool` objects represent workload identities in Confluent Cloud.\n\nThe API allows you to list, create, read, update, and delete your identity pools associated\nwith Certificate Authorities\n\n\nRelated 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).\n\n## The Certificate Identity Pools Model\n<SchemaDefinition schemaRef=\"#/components/schemas/iam.v2.CertificateIdentityPool\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority |"
},
{
"name": "Integrations (pim/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Provider Integration` objects represent access to public cloud service provider (CSP) resources\nthat may be accessed by Confluent resources (for example, connectors).\n\nThe API allows you to create, retrieve, and delete individual integrations, and also obtain a\nlist of all your provider integrations.\n\n\nRelated guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html).\n\n## The Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/pim.v1.Integration\" />"
},
{
"name": "Flink Artifacts (artifact/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nFlinkArtifact objects represent Flink Artifacts on Confluent Cloud.\n\n\n## The Flink Artifacts Model\n<SchemaDefinition schemaRef=\"#/components/schemas/artifact.v1.FlinkArtifact\" />"
},
{
"name": "Presigned Urls (artifact/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nRequest a presigned upload URL for new Flink Artifact. Note that\nthe URL policy expires in one hour. If the policy expires, you can request\na new presigned upload URL.\n\n\n## The Presigned Urls Model\n<SchemaDefinition schemaRef=\"#/components/schemas/artifact.v1.PresignedUrl\" />"
},
{
"name": "Flink Artifact Versions (artifact/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nFlinkArtifactVersion objects represent Flink Artifact Versions on Confluent Cloud.\n\n\n## The Flink Artifact Versions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/artifact.v1.FlinkArtifactVersion\" />"
},
{
"name": "Gateways (networking/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nA Gateway represents a slice of traffic capacity in a region that is reserved for a customer.\n\n\n## The Gateways Model\n<SchemaDefinition schemaRef=\"#/components/schemas/networking.v1.Gateway\" />\n\n## Quotas and Limits\nThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):\n\n| Quota | Description |\n| --- | --- |\n| `gateways_per_region_per_environment` | Number of Gateways per region per environment |"
},
{
"name": "Custom Code Loggings (ccl/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy) [](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.)\n\nCustomCodeLogging objects represent Custom Code Logging on Confluent Cloud.\nThe API allows you to list, create, read, update, and delete your Custom Code Logging.\n\n\n## The Custom Code Loggings Model\n<SchemaDefinition schemaRef=\"#/components/schemas/ccl.v1.CustomCodeLogging\" />"
},
{
"name": "Regions (tableflow/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\n`Region` objects represent cloud provider regions where Tableflow can be enabled.\nThis API allows you to list all supported Tableflow regions.\n\n\n## The Regions Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.Region\" />"
},
{
"name": "Tableflow Topics (tableflow/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nA Tableflow Topic represents configuration related to a Tableflow enabled kafka topic\n\n\n## The Tableflow Topics Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.TableflowTopic\" />"
},
{
"name": "Catalog Integrations (tableflow/v1)",
"description": "[](#section/Versioning/API-Lifecycle-Policy)\n\nA Catalog Integration represents configuration related to a catalog integration\n\n\n## The Catalog Integrations Model\n<SchemaDefinition schemaRef=\"#/components/schemas/tableflow.v1.CatalogIntegration\" />"
}
]
}