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

Confluent Provider Shares (cdx/v1) API

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)`ProviderShare` object respresents the share that you have created through Stream Sharing.Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares).## The Provider Shares Model

Confluent Provider Shares (cdx/v1) API is one of 127 APIs that Confluent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Provider Shares (cdx/v1). The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.confluent.cloud.

5 operations 3 paths 13 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.confluent.cloud
Authentication
HTTP Basic, OAuth 2.0, HTTP Basic, HTTP Basic, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 6

Confluent Provider Shares (cdx/v1) API declares 6 security schemes for authenticating requests. It accepts HTTP basic authentication (cloud-api-key). It supports OAuth 2.0 (confluent-sts-access-token) using the clientCredentials flow. It accepts HTTP basic authentication (global-api-key). It accepts HTTP basic authentication (resource-api-key). It supports OAuth 2.0 (external-access-token) using the clientCredentials flow. It supports OAuth 2.0 (oauth) using the clientCredentials flow, exposing 4 scopes.

  • cloud-api-key — 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 — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • global-api-key — Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
  • resource-api-key — 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…
  • external-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • oauth — Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Provider Shares (cdx/v1) 5

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](section/Versioning/API-Lifecycle-Policy) ProviderShare object respresent…

GET
/cdx/v1/provider-shares
List of Provider Shares
listCdxV1ProviderShares 5 params → 200400401403429500
POST
/cdx/v1/provider-shares
Create a provider share
createCdxV1ProviderShare body → 201400401403409422429500
GET
/cdx/v1/provider-shares/{id}
Read a Provider Share
getCdxV1ProviderShare 1 param → 200400401403404429500
DELETE
/cdx/v1/provider-shares/{id}
Delete a Provider Share
deleteCdxV1ProviderShare 1 param → 204400401403404429500
POST
/cdx/v1/provider-shares/{id}:resend
Resend
resendCdxV1ProviderShare 1 param → 204400401403404429500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are cdx.v1.ProviderShare (16 properties), Error (8 properties), cdx.v1.CreateProviderShareRequest (7 properties), ListMeta (5 properties). Each schema is shown below with its type and property counts.

ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
5 properties 1 required
ListMeta
object
ListMeta describes metadata that resource collections may have
5 properties
cdx.v1.ProviderShareList
object
ProviderShare object respresents the share that you have created through Stream Sharing. Related guide: [Provider Stream Shares in Confluent Cloud](https://doc…
4 properties 4 required
cdx.v1.CreateProviderShareRequest
object
Create share request
7 properties
cdx.v1.ProviderShare
object
ProviderShare object respresents the share that you have created through Stream Sharing. Related guide: [Provider Stream Shares in Confluent Cloud](https://doc…
16 properties
cdx.v1.EmailConsumerRestriction
object
Consumer restrictions limits by authenticated user's email
2 properties 2 required
EnvScopedObjectReference
object
ObjectReference provides information for you to locate the referred object
4 properties 3 required
SearchFilter
string
Filter a collection by a string search
BooleanFilter
boolean
Filter for whether this value is true or false.
Error
object
Describes a particular error encountered while performing an operation.
8 properties
GlobalObjectReference
object
ObjectReference provides information for you to locate the referred object
3 properties 3 required
Failure
object
Provides information about problems encountered while performing an operation.
1 property 1 required
cdx.v1.ProviderShareStatus
object
The status of the Provider Share
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluent-provider-shares-cdx-v1-api-openapi.yml Raw ↑

Other APIs Confluent publishes across the network.

Confluent
Confluent Managed MCP Servers
Confluent ACLs API
Confluent API Keys API
Confluent Clusters API
Confluent Consumer Groups API
Confluent Environments API
Confluent Partitions API
Confluent Service Accounts API
Confluent Topics API
Confluent Access Points (networking/v1) API
Confluent ACL (v3) API
Where this information came from

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

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

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

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