List of Connections
GET/sql/v1/organizations/:organization_id/environments/:environment_id/connections
Retrieve a sorted, filtered and paginated list of all Connections.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Connections.
Response Headers
X-Request-Id
The unique identifier for the API request.
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:
/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections:
get:
x-lifecycle-stage: Preview
x-self-access: true
x-request-access-name: SQL API v1
operationId: listSqlv1Connections
description: '[](#section/Versioning/API-Lifecycle-Policy)
Retrieve a sorted, filtered and paginated list of all Connections.'
parameters:
- in: path
name: organization_id
required: true
schema:
type: string
format: uuid
description: The unique identifier for the organization.
- in: path
name: environment_id
required: true
schema:
type: string
description: The unique identifier for the environment.
- name: spec.connection_type
in: query
required: false
schema:
type: string
enum:
- AZUREML
- AZUREOPENAI
- A2A
- ANTHROPIC
- BEDROCK
- CONFLUENT_JDBC
- COSMOSDB
- COUCHBASE
- ELASTIC
- FIREWORKSAI
- GOOGLEAI
- MCP_SERVER
- MONGODB
- OPENAI
- PINECONE
- REST
- S3VECTORS
- SAGEMAKER
- VERTEXAI
description: Filter the results by exact match for spec.connection_type
- name: page_size
in: query
required: false
schema:
type: integer
default: 10
maximum: 100
x-max-page-items: 500
description: A pagination size for collection requests.
- name: page_token
in: query
required: false
schema:
type: string
maxLength: 255
description: An opaque pagination token for collection requests.
tags:
- Connections (sql/v1)
security:
- resource-api-key: []
- global-api-key: []
responses:
'200':
description: Connections.
content:
application/json:
schema:
type: object
description: '`Connection` models a reusable endpoint and auth token to authenticate the
caller to
use that endpoint.
Only `OrgAdmins` and `EnvAdmins` will have the permissions to create, update and delete
`Connections`.
`FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource
within their Model
creation statements.
The API allows you to list, create, read, and delete your connections.
## The Connection Model
<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:
- type: object
description: ListMeta describes metadata that resource collections may have
properties:
first:
description: A link to the first page of results. If a response does not contain
a first link, then direct navigation to the first page is not supported.
type: string
format: uri
nullable: true
example: https://api.confluent.cloud/v2/resourcekinds
last:
description: A link to the last page of results. If a response does not contain
a last link, then direct navigation to the last page is not supported.
type: string
format: uri
nullable: true
example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT
prev:
description: A link to the previous page of results. If a response does not
contain a prev link, then either there is no previous data or backwards traversal
through the result set is not supported.
type: string
format: uri
nullable: true
example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld
next:
description: A link to the next page of results. If a response does not contain
a next link, then there is no more data available.
type: string
format: uri
nullable: true
example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb
total_size:
description: Number of records in 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:
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:
- type: object
description: '`Connection` models a reusable endpoint and auth token to authenticate
the caller to
use that endpoint.
Only `OrganizationAdmins` and `EnvironmentAdmins` will have the permissions
to create, update and delete `Connections`.
`FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection`
resource within their Model
creation statements.
The API allows you to list, create, read, and delete your connections.
## The Connections Model
<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:
- description: ObjectMeta is metadata that all persisted resources must have,
which includes all objects users must create.
required:
- self
properties:
self:
description: Self is a Uniform Resource Locator (URL) at which an object
can be addressed. This URL encodes the service location, API version,
and other particulars necessary to locate the resource at a point
in time
type: string
format: uri
readOnly: true
example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de
resource_name:
description: Resource Name is a Uniform Resource Identifier (URI) that
is globally unique across space and time. It is represented as a Confluent
Resource Name
type: string
format: uri
readOnly: true
example: crn://confluent.cloud/kafka=lkc-f3a90de
created_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was created. It
is represented in RFC3339 format and is in UTC.
updated_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was last updated.
It is represented in RFC3339 format and is in UTC.
deleted_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The 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://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:
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
enum:
- AZUREML
- AZUREOPENAI
- A2A
- ANTHROPIC
- BEDROCK
- CONFLUENT_JDBC
- COSMOSDB
- COUCHBASE
- ELASTIC
- FIREWORKSAI
- GOOGLEAI
- MCP_SERVER
- MONGODB
- OPENAI
- PINECONE
- REST
- S3VECTORS
- SAGEMAKER
- VERTEXAI
endpoint:
type: string
example: https://api.openai.com/v1/chat/completions
description: The endpoint that is used to run model inferencing.
maxLength: 16384
x-immutable: true
auth_data:
type: object
description: 'The vendor specific authentication token details
The contents are stored as opaque bytes given in plaintext by an EnvAdmin.
In future, we would support more secure methods for distributing authentication
tokens.
'
discriminator:
propertyName: kind
mapping:
PlaintextProvider:
type: object
description: 'Describes a sensitive piece of information passed
in plaintext.
Confluent only accepts authentication tokens of supported model
providers from OrgAdmins and EnvAdmins.
For now, only ''PlainText'' provider is supported. It stores authentication
token details as opaque bytes in an encrypted form.
This option offers limited security as it only provides a single
level of encryption.
'
properties:
kind:
description: 'Plaintext Provider Kind Type
'
type: string
enum:
- PlaintextProvider
x-immutable: true
data:
description: 'Authentication token in plaintext JSON string.
For composite tokens, provide them as JSON.
This is sensitive piece of information stored as opaque bytes
in an encrypted form with single level of encryption.
Scoped to an endpoint of a `Connection` resource.
'
type: string
format: byte
title: sql.v1.PlaintextProvider
oneOf:
- type: object
description: 'Describes a sensitive piece of information passed in plaintext.
Confluent only accepts authentication tokens of supported model providers
from OrgAdmins and EnvAdmins.
For now, only ''PlainText'' provider is supported. It stores authentication
token details as opaque bytes in an encrypted form.
This option offers limited security as it only provides a single level
of encryption.
'
properties:
kind:
description: 'Plaintext Provider Kind Type
'
type: string
enum:
- PlaintextProvider
x-immutable: true
data:
description: 'Authentication token in plaintext JSON string.
For composite tokens, provide them as JSON.
This is sensitive piece of information stored as opaque bytes
in an encrypted form with single level of encryption.
Scoped to an endpoint of a `Connection` resource.
'
type: string
format: byte
title: sql.v1.PlaintextProvider
x-immutable: false
x-enable-listmeta: true
x-enable-objectmeta: true
title: sql.v1.ConnectionSpec
status:
type: object
required:
- phase
description: The status of the Connection
properties:
phase:
type: string
description: 'Describes the status of the connection:
READY: The Connection is usable;
UNREACHABLE: The Connection endpoint is unreachable;
INVALID_AUTH: The Connection auth token is invalid;
'
example: READY
readOnly: true
enum:
- ACTIVE
- UNREACHABLE
- INVALID_AUTH
detail:
type: string
description: Details about why connection transitioned into a given status.
example: 'Lookup failed: ai.openai.com'
readOnly: true
readOnly: true
title: sql.v1.ConnectionStatus
title: sql.v1.Connection
- type: object
required:
- api_version
- kind
- metadata
- spec
- status
- name
properties:
spec:
type: object
required:
- connection_type
- endpoint
uniqueItems: true
title: sql.v1.ConnectionList
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
'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://flink.region.provider.confluent.cloud
description: Flink Compute Pool Endpoint