List of Tableflow Topics
GET/tableflow/v1/tableflow-topics
Retrieve a sorted, filtered, paginated list of all tableflow topics.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Tableflow Topic.
Response Headers
X-Request-Id
The unique identifier for the API request.
X-RateLimit-Limit
The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining
The number of requests remaining in the current rate limit window.
X-RateLimit-Reset
The relative time in seconds until the current rate-limit window resets.
Important: This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues.
Bad Request
Response Headers
X-Request-Id
The unique identifier for the API request.
The request lacks valid authentication credentials for this resource.
Response Headers
X-Request-Id
The unique identifier for the API request.
WWW-Authenticate
The unique identifier for the API request.
Example:
Basic error="invalid_key", error_description="The API Key is invalid"The access credentials were considered insufficient to grant access
Response Headers
X-Request-Id
The unique identifier for the API request.
Rate Limit Exceeded
Response Headers
X-Request-Id
The unique identifier for the API request.
X-RateLimit-Limit
The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining
The number of requests remaining in the current rate limit window.
X-RateLimit-Reset
The relative time in seconds until the current rate-limit window resets.
Important: This differs 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
The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.
Oops, something went wrong!
Response Headers
X-Request-Id
The unique identifier for the API request.
OpenAPI definition (YAML)
paths:
/tableflow/v1/tableflow-topics:
get:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: listTableflowV1TableflowTopics
description: '[](#section/Versioning/API-Lifecycle-Policy)
Retrieve a sorted, filtered, paginated list of all tableflow topics.'
parameters:
- name: spec.table_formats
in: query
required: false
schema:
description: Filter a collection by a string search for one or more values
type: array
items:
type: string
title: MultipleSearchFilter
example:
- DELTA
- ICEBERG
description: Filter the results by exact match for spec.table_formats. Pass multiple times to
see results matching any of the values.
style: form
explode: true
- name: environment
in: query
required: true
schema:
description: Filter a collection by a string search
type: string
title: SearchFilter
example: env-00000
description: Filter the results by exact match for environment.
- name: spec.kafka_cluster
in: query
required: true
schema:
description: Filter a collection by a string search
type: string
title: 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:
- type: object
description: 'A Tableflow Topic represents configuration related to a Tableflow enabled
kafka topic
## The Tableflow Topics Model
<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:
- type: object
description: ListMeta describes metadata that resource collections may have
properties:
first:
description: A link to the first page of results. If a response does not contain
a first link, then direct navigation to the first page is not supported.
type: string
format: uri
nullable: true
example: https://api.confluent.cloud/v2/resourcekinds
last:
description: A link to the last page of results. If a response does not contain
a last link, then direct navigation to the last page is not supported.
type: string
format: uri
nullable: true
example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT
prev:
description: A link to the previous page of results. If a response does not
contain a prev link, then either there is no previous data or backwards
traversal through the result set is not supported.
type: string
format: uri
nullable: true
example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld
next:
description: A link to the next page of results. If a response does not contain
a next link, then there is no more data available.
type: string
format: uri
nullable: true
example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb
total_size:
description: Number of records in the full result set. This response may be
paginated and have a smaller number of records.
type: integer
format: int32
minimum: 0
example: 123
title: 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:
- type: object
description: 'A Tableflow Topic represents configuration related to a Tableflow
enabled kafka topic
## The Tableflow Topics Model
<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:
- description: ObjectMeta is metadata that all persisted resources must
have, which includes all objects users must create.
required:
- self
properties:
self:
description: Self is a Uniform Resource Locator (URL) at which an
object can be addressed. This URL encodes the service location,
API version, and other particulars necessary to locate the resource
at a point in time
type: string
format: uri
readOnly: true
example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de
resource_name:
description: Resource Name is a Uniform Resource Identifier (URI)
that is globally unique across space and time. It is represented
as a Confluent Resource Name
type: string
format: uri
readOnly: true
example: crn://confluent.cloud/kafka=lkc-f3a90de
created_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was created. It
is represented in RFC3339 format and is in UTC.
updated_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was last updated.
It is represented in RFC3339 format and is in UTC.
deleted_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was (or will be)
deleted. It is represented in RFC3339 format and is in UTC.
readOnly: true
title: 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:
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:
- type: object
description: The configs for the Tableflow enabled topic
properties:
enable_compaction:
description: This flag determines whether to enable compaction
for the Tableflow enabled topic.
type: boolean
example: true
x-immutable: true
readOnly: true
enable_partitioning:
description: This flag determines whether to enable partitioning
for the Tableflow enabled topic.
type: boolean
example: true
x-immutable: true
readOnly: true
retention_ms:
description: 'The maximum age, in milliseconds, of snapshots (for
Iceberg) or versions (for Delta)
to retain in the table for the Tableflow-enabled topic (snapshot/version
expiration).
The default value is "604800000" milliseconds (equivalent to
7 days).
The minimum allowed value is "86400000" milliseconds (equivalent
to 24 hours).
'
type: string
format: int64
example: '7776000000'
data_retention_ms:
description: 'The maximum age, in milliseconds, of data to retain
in the table for the Tableflow-enabled topic.
The minimum allowed non-zero value is "2592000000" milliseconds
(equivalent to 30 days).
Set to "0" to disable data retention (keep all data indefinitely).
Note - The attribute is in a [Limited Availability lifecycle
stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
'
type: string
format: int64
example: '2592000000'
record_failure_strategy:
description: 'The strategy to handle record failures in the Tableflow
enabled topic during materialization.
For `SKIP`, we skip the bad records and move to the next record,
and for `SUSPEND`, we suspend the materialization of the topic.
'
type: string
default: SUSPEND
deprecated: true
enum:
- SUSPEND
- SKIP
error_handling:
type: object
description: 'The error mode to handle record failures in the
Tableflow enabled topic during materialization.
for `SKIP`, we skip the bad records and move to the next record,
for `SUSPEND`, we suspend the materialization of the topic,
and for `LOG`, we log the bad records to the DLQ and continue
processing the rest of the records.
'
oneOf:
- type: object
description: 'Configuration for the `SUSPEND` error handling
mode.
'
properties:
mode:
type: string
enum:
- SUSPEND
description: 'The error handling mode for the Tableflow
enabled topic.
In this mode, the materialization of the topic is suspended
in case of record failures.
'
required:
- mode
title: tableflow.v1.ErrorHandlingSuspend
- type: object
description: 'Configuration for the `SKIP` error handling mode.
'
properties:
mode:
type: string
enum:
- SKIP
description: 'The error handling mode for the Tableflow
enabled topic.
In this mode, the bad records are skipped and the materialization
continues with the next record.
'
required:
- mode
title: tableflow.v1.ErrorHandlingSkip
- type: object
description: 'Configuration for the `LOG` error handling mode.
'
properties:
mode:
type: string
enum:
- LOG
description: 'The error handling mode for the Tableflow
enabled topic.
In this mode, the bad records are logged to a dead-letter
queue (DLQ) topic and the
materialization continues with the next record.
'
target:
type: string
description: 'The topic to which the bad records will be
logged in case of `LOG` error handling mode.
Creates the topic if it doesn''t already exist; otherwise,
the operation is idempotent and no action is taken.
Default topic is `error_log`.
'
default: error_log
required:
- mode
title: tableflow.v1.ErrorHandlingLog
discriminator:
propertyName: mode
mapping:
SUSPEND:
type: object
description: 'Configuration for the `SUSPEND` error handling
mode.
'
properties:
mode:
type: string
enum:
- SUSPEND
description: 'The error handling mode for the Tableflow
enabled topic.
In this mode, the materialization of the topic is
suspended in case of record failures.
'
required:
- mode
title: tableflow.v1.ErrorHandlingSuspend
SKIP:
type: object
description: 'Configuration for the `SKIP` error handling
mode.
'
properties:
mode:
type: string
enum:
- SKIP
description: 'The error handling mode for the Tableflow
enabled topic.
In this mode, the bad records are skipped and the
materialization continues with the next record.
'
required:
- mode
title: tableflow.v1.ErrorHandlingSkip
LOG:
type: object
description: 'Configuration for the `LOG` error handling
mode.
'
properties:
mode:
type: string
enum:
- LOG
description: 'The error handling mode for the Tableflow
enabled topic.
In this mode, the bad records are logged to a dead-letter
queue (DLQ) topic and the
materialization continues with the next record.
'
target:
type: string
description: 'The topic to which the bad records will
be logged in case of `LOG` error handling mode.
Creates the topic if it doesn''t already exist; otherwise,
the operation is idempotent and no action is taken.
Default topic is `error_log`.
'
default: error_log
required:
- mode
title: tableflow.v1.ErrorHandlingLog
title: tableflow.v1.TableFlowTopicConfigsSpec
storage:
type: object
description: The storage config
oneOf:
- type: object
description: The Tableflow storage config for BYOB enabled topic in
AWS
required:
- kind
- bucket_name
- provider_integration_id
properties:
kind:
type: string
enum:
- ByobAws
description: 'The storage type
'
x-immutable: true
bucket_name:
description: Bucket name
type: string
example: bucket_1
x-immutable: true
bucket_region:
description: Bucket region
type: string
example: us-east-1
x-immutable: true
readOnly: true
provider_integration_id:
type: string
description: The provider integration id
example: cspi-stgce89r7
x-immutable: true
table_path:
type: string
description: The current storage path where the data and metadata
is stored for this table
example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId
readOnly: true
title: tableflow.v1.ByobAwsSpec
- type: object
description: The storage config for confluent managed Tableflow enabled
topic.
required:
- kind
properties:
kind:
type: string
enum:
- Managed
description: 'The storage type.
'
x-immutable: true
table_path:
type: string
description: The current storage path where the data and metadata
is stored for this table
example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId
readOnly: true
title: tableflow.v1.ManagedStorageSpec
- type: object
description: The Tableflow storage config for customer-owned Azure
Data Lake Storage Gen2
required:
- kind
- storage_account_name
- container_name
- provider_integration_id
properties:
kind:
type: string
enum:
- AzureDataLakeStorageGen2
description: 'The storage type.
'
x-immutable: true
storage_account_name:
description: Storage Account Name
type: string
example: confluentstorage1
x-immutable: true
container_name:
description: Container name
type: string
example: container-tableflow
x-immutable: true
storage_region:
description: Storage account region
type: string
example: centralus
readOnly: true
provider_integration_id:
type: string
description: The provider integration id
example: cspi-6nxn5
x-immutable: true
table_path:
type: string
description: The current storage path where the data and metadata
is stored for this table
example: abfss://container@account.dfs.core.windows.net/10011010/11101100/org/env/lkc/v1/tableId
readOnly: true
title: tableflow.v1.AzureAdlsSpec
discriminator:
propertyName: kind
mapping:
ByobAws:
type: object
description: The Tableflow storage config for BYOB enabled topic
in AWS
required:
- kind
- bucket_name
- provider_integration_id
properties:
kind:
type: string
enum:
- ByobAws
description: 'The storage type
'
x-immutable: true
bucket_name:
description: Bucket name
type: string
example: bucket_1
x-immutable: true
bucket_region:
description: Bucket region
type: string
example: us-east-1
x-immutable: true
readOnly: true
provider_integration_id:
type: string
description: The provider integration id
example: cspi-stgce89r7
x-immutable: true
table_path:
type: string
description: The current storage path where the data and metadata
is stored for this table
example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId
readOnly: true
title: tableflow.v1.ByobAwsSpec
Managed:
type: object
description: The storage config for confluent managed Tableflow
enabled topic.
required:
- kind
properties:
kind:
type: string
enum:
- Managed
description: 'The storage type.
'
x-immutable: true
table_path:
type: string
description: The current storage path where the data and metadata
is stored for this table
example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId
readOnly: true
title: tableflow.v1.ManagedStorageSpec
AzureDataLakeStorageGen2:
type: object
description: The Tableflow storage config for customer-owned Azure
Data Lake Storage Gen2
required:
- kind
- storage_account_name
- container_name
- provider_integration_id
properties:
kind:
type: string
enum:
- AzureDataLakeStorageGen2
description: 'The storage type.
'
x-immutable: true
storage_account_name:
description: Storage Account Name
type: string
example: confluentstorage1
x-immutable: true
container_name:
description: Container name
type: string
example: container-tableflow
x-immutable: true
storage_region:
description: Storage account region
type: string
example: centralus
readOnly: true
provider_integration_id:
type: string
description: The provider integration id
example: cspi-6nxn5
x-immutable: true
table_path:
type: string
description: The current storage path where the data and metadata
is stored for this table
example: abfss://container@account.dfs.core.windows.net/10011010/11101100/org/env/lkc/v1/tableId
readOnly: true
title: tableflow.v1.AzureAdlsSpec
x-immutable: true
table_formats:
type: array
description: 'The supported table formats for the Tableflow-enabled
topic.
'
items:
type: string
enum:
- DELTA
- ICEBERG
minItems: 1
uniqueItems: true
example:
- DELTA
default:
- ICEBERG
environment:
allOf:
- 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
title: GlobalObjectReference
description: The environment to which the target Kafka cluster belongs.
kafka_cluster:
allOf:
- 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
title: 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
title: tableflow.v1.TableflowTopicSpec
status:
type: object
required:
- write_mode
description: The status of the Tableflow Topic
properties:
phase:
type: string
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
enum:
- PENDING
- RUNNING
- FAILED
error_message:
type: string
description: Displayable error message if Tableflow topic is in an error
state
example: Could not enable catalog integration
readOnly: true
catalog_sync_statuses:
type: array
description: 'List of associated catalogs and their synchronization
statuses for this Tableflow topic.
'
items:
type: object
description: The synchronization status of an external catalog for
a Tableflow topic
properties:
catalog_integration_id:
type: string
description: The ID of the catalog integration
example: tci-12345
catalog_type:
type: string
description: The type of the external catalog
example: AWS_GLUE
enum:
- AWS_GLUE
- SNOWFLAKE
- UNITY
sync_status:
type: string
description: "The current synchronization status:\n\n PENDING:\
\ sync is pending;\n\n SYNCED: successfully synced;\n\n FAILED:\
\ sync failed;\n\n DISCONNECTED: catalog integration is disconnected.\n"
example: SYNCED
enum:
- PENDING
- SYNCED
- FAILED
- DISCONNECTED
error_message:
type: string
nullable: true
description: 'Error message if the sync failed. This field is
only present when `sync_status` is `FAILED`.
'
example: 'Failed to connect to catalog: authentication error'
title: tableflow.v1.CatalogSyncStatus
readOnly: true
failing_table_formats:
type: array
items:
type: object
properties:
format:
type: string
description: The name of the table format (e.g., DELTA, ICEBERG).
enum:
- DELTA
- ICEBERG
error_message:
type: string
description: The error message for the failing table format.
required:
- format
- error_message
description: 'List of failing table formats for the Tableflow-enabled
topic, including error details.
'
example:
- format: ICEBERG
error_message: Schema validation failed
- format: DELTA
error_message: Connection timeout
readOnly: true
write_mode:
type: string
description: 'The write mode for the Tableflow-enabled topic, determining
how data is written to the table.
'
example: APPEND
readOnly: true
enum:
- APPEND
- UPSERT
- UPSERT_HISTORY
readOnly: true
title: tableflow.v1.TableflowTopicStatus
title: tableflow.v1.TableflowTopic
- type: object
required:
- metadata
- spec
- status
properties:
spec:
type: object
required:
- display_name
- storage
- environment
- kafka_cluster
uniqueItems: true
title: 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':
description: Bad Request
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
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:
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
title: Error
uniqueItems: true
title: 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
'401':
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:
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:
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
title: Error
uniqueItems: true
title: Failure
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '401'
code: user_unauthenticated
title: Authentication Required
detail: Valid authentication credentials must be provided
'403':
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:
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:
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
title: Error
uniqueItems: true
title: 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.
'429':
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.
'500':
description: Oops, something went wrong!
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
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:
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
title: Error
uniqueItems: true
title: Failure
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '500'
code: out_of_gas
title: DeLorean Out Of Gas
detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap
servers:
- url: https://api.confluent.cloud
description: Confluent Cloud API