Read a Catalog Integration
GET/tableflow/v1/catalog-integrations/:id
Make a request to read a catalog integration.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Catalog Integration.
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.
Not Found
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/catalog-integrations/{id}:
get:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: getTableflowV1CatalogIntegration
description: '[](#section/Versioning/API-Lifecycle-Policy)
Make a request to read a catalog integration.'
parameters:
- name: environment
in: query
required: true
schema:
description: Filter a collection by a string search
type: string
title: SearchFilter
example: env-00000
description: Scope the operation to the given 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: 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:
- type: object
description: 'A Catalog Integration represents configuration related to a catalog integration
## The Catalog Integrations Model
<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:
- description: ObjectMeta is metadata that all persisted resources must have, which
includes all objects users must create.
required:
- self
properties:
self:
description: Self is a Uniform Resource Locator (URL) at which an object can
be addressed. This URL encodes the service location, API version, and other
particulars necessary to locate the resource at a point in time
type: string
format: uri
readOnly: true
example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de
resource_name:
description: Resource Name is a Uniform Resource Identifier (URI) that is
globally unique across space and time. It is represented as a Confluent
Resource Name
type: string
format: uri
readOnly: true
example: crn://confluent.cloud/kafka=lkc-f3a90de
created_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was created. It is represented
in RFC3339 format and is in UTC.
updated_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was last updated. It is
represented in RFC3339 format and is in UTC.
deleted_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The 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/catalog-integrations/tci-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/catalog-integration=tci-12345
spec:
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:
- 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
custom_database:
type: string
description: The custom database name to use in AWS Glue.
title: tableflow.v1.CatalogIntegrationAwsGlueSpec
- type: object
description: The catalog integration connection config for Snowflake Open
Catalog.
required:
- kind
- endpoint
- client_id
- client_secret
- warehouse
- allowed_scope
properties:
kind:
type: string
enum:
- Snowflake
description: The type of the catalog integration.
endpoint:
description: 'The catalog integration connection endpoint for Snowflake
Open Catalog.
'
type: string
example: https://vuser1_polaris.snowflakecomputing.com/
client_id:
description: The client ID of the catalog integration.
type: string
client_secret:
description: The client secret of the catalog integration.
type: string
warehouse:
description: Warehouse name of the Snowflake Open Catalog.
type: string
allowed_scope:
description: Allowed scope of the Snowflake Open Catalog.
type: string
custom_namespace:
type: string
description: The custom namespace to use in Snowflake Open Catalog.
title: tableflow.v1.CatalogIntegrationSnowflakeSpec
- type: object
description: The catalog integration connection config for Unity Catalog.
required:
- kind
- workspace_endpoint
- catalog_name
- client_id
- client_secret
properties:
kind:
type: string
enum:
- Unity
description: The type of the catalog integration.
workspace_endpoint:
type: string
description: The Databricks workspace URL associated with the Unity Catalog.
example: https://user1.cloud.databricks.com
catalog_name:
type: string
description: The name of the catalog within Unity Catalog.
client_id:
type: string
description: The OAuth client ID used to authenticate with the Unity Catalog.
client_secret:
type: string
description: The OAuth client secret used for authentication with the
Unity Catalog.
custom_schema:
type: string
description: The custom schema name to use in Unity Catalog.
title: tableflow.v1.CatalogIntegrationUnitySpec
discriminator:
propertyName: kind
mapping:
AwsGlue:
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
custom_database:
type: string
description: The custom database name to use in AWS Glue.
title: tableflow.v1.CatalogIntegrationAwsGlueSpec
Snowflake:
type: object
description: The catalog integration connection config for Snowflake Open
Catalog.
required:
- kind
- endpoint
- client_id
- client_secret
- warehouse
- allowed_scope
properties:
kind:
type: string
enum:
- Snowflake
description: The type of the catalog integration.
endpoint:
description: 'The catalog integration connection endpoint for Snowflake
Open Catalog.
'
type: string
example: https://vuser1_polaris.snowflakecomputing.com/
client_id:
description: The client ID of the catalog integration.
type: string
client_secret:
description: The client secret of the catalog integration.
type: string
warehouse:
description: Warehouse name of the Snowflake Open Catalog.
type: string
allowed_scope:
description: Allowed scope of the Snowflake Open Catalog.
type: string
custom_namespace:
type: string
description: The custom namespace to use in Snowflake Open Catalog.
title: tableflow.v1.CatalogIntegrationSnowflakeSpec
Unity:
type: object
description: The catalog integration connection config for Unity Catalog.
required:
- kind
- workspace_endpoint
- catalog_name
- client_id
- client_secret
properties:
kind:
type: string
enum:
- Unity
description: The type of the catalog integration.
workspace_endpoint:
type: string
description: The Databricks workspace URL associated with the Unity
Catalog.
example: https://user1.cloud.databricks.com
catalog_name:
type: string
description: The name of the catalog within Unity Catalog.
client_id:
type: string
description: The OAuth client ID used to authenticate with the Unity
Catalog.
client_secret:
type: string
description: The OAuth client secret used for authentication with
the Unity Catalog.
custom_schema:
type: string
description: The custom schema name to use in Unity Catalog.
title: tableflow.v1.CatalogIntegrationUnitySpec
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: true
x-enable-listmeta: true
x-enable-objectmeta: true
title: tableflow.v1.CatalogIntegrationSpec
status:
description: The status of the Catalog Integration
type: object
properties:
phase:
type: string
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
enum:
- PENDING
- CONNECTED
- FAILED
error_message:
type: string
description: Displayable error message if catalog integration is in a failed
state.
example: Could not enable catalog integration
readOnly: true
last_sync_at:
type: string
description: 'The date and time at which the catalog was last synced. It is
represented in RFC3339 format and is in UTC.
'
readOnly: true
readOnly: true
title: tableflow.v1.CatalogIntegrationStatus
title: 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':
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.
'404':
description: Not Found
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: '404'
title: Not Found
'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