Execute SQL Statement
POST/query/v1alpha1
Executes an arbitrary SQL query against the engine. If the query resolves in under 30 seconds and returns less than 25 MiB, the response will be an inline HTTP 200 OK. Otherwise, a 202 Accepted response redirects the client to retrieve results from a separate streamed data location. Rows are returned as JSON strings by default; set options.result_format to ARROW_STREAM to receive a base64-encoded Arrow IPC stream with native column types instead.
Request
Responses
- 200
- 202
- 400
- 401
- 403
- 404
- 429
- 500
Successful synchronous response containing fully inlined metadata and data results.
Response Headers
X-Request-Id
Unique identifier for this request, useful for support and debugging
Asynchronous request registration. Returned when data sets exceed 25 MiB or execution times cross the 30s processing barrier.
Response Headers
X-Request-Id
Unique identifier for this request, useful for support and debugging
Location
Complete URL path indicating where the client can poll for state changes.
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:
/query/v1alpha1:
post:
description: 'Executes an arbitrary SQL query against the engine. If the query resolves in under
30 seconds and returns less than 25 MiB, the response will be an inline HTTP 200 OK. Otherwise,
a 202 Accepted response redirects the client to retrieve results from a separate streamed data
location. Rows are returned as JSON strings by default; set `options.result_format` to `ARROW_STREAM`
to receive a base64-encoded Arrow IPC stream with native column types instead.
'
operationId: executeQueryV1alpha1Statement
x-lifecycle-stage: Early Access
tags:
- Statements (query/v1alpha1)
security:
- resource-api-key: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- catalog_name
- database_name
- query
description: Request parameters for query analysis and extraction.
properties:
catalog_name:
type: string
description: Confluent Cloud environment ID (e.g., env-xyz123)
database_name:
type: string
description: Kafka cluster ID (e.g., lkc-xyz123)
options:
description: Options for this query.
allOf:
- type: object
description: 'Settings that tune how this query is handled. Omitted fields fall back
to service defaults.
'
properties:
max_result_rows:
type: integer
format: int32
minimum: 1
maximum: 200
description: Maximum rows to return up to configured limit.
result_format:
type: string
default: JSON
description: 'Encoding for the returned rows, echoed back as `result.result_format`.
`JSON` returns `result.data` as an array of rows, requiring clients to coerce
values using `result.schema`. `ARROW_STREAM` returns `result.data` as a base64-encoded
Arrow IPC stream, preserving native column types. Inline `ARROW_STREAM` payloads
are size-capped; larger results are delivered through the asynchronous 202 flow.
'
enum:
- JSON
- ARROW_STREAM
title: query.v1alpha1.QueryOptions
query:
type: string
description: SQL query to execute
client_info:
type: object
additionalProperties:
type: string
description: 'Free-form client metadata for telemetry and debugging (e.g., client_name,
client_version, driver_version). Values are strings; not interpreted by the server.
'
title: query.v1alpha1.QueryRequest
examples:
show_tables:
summary: List the tables in a cluster
description: 'Metadata is discovered with `SHOW TABLES` and `DESCRIBE`. Both return the
same result envelope as `SELECT`.
'
value:
catalog_name: env-xyz123
database_name: lkc-xyz123
query: SHOW TABLES
describe_table:
summary: Describe a table's columns
description: 'Returns one row per column. The values in the `type` column are the CLI/UI
rendering of the Flink type — `BYTES`, `STRING`, `ROW<...>` — which is a different rendering
of the same type system that `schema.columns[].type` describes as JSON.
'
value:
catalog_name: env-xyz123
database_name: lkc-xyz123
query: DESCRIBE orders
select_with_limit:
summary: SELECT with LIMIT
description: 'Omitting `options.result_format` defaults to `JSON`, returning rows as arrays
of JSON strings.
'
value:
catalog_name: env-xyz123
database_name: lkc-xyz123
query: SELECT l_orderkey, l_quantity, l_description FROM "order" LIMIT 5
select_with_limit_arrow:
summary: SELECT with LIMIT (Arrow result format)
description: 'Requests the same rows as a base64-encoded Arrow IPC stream, preserving
native column types instead of stringifying them.
'
value:
catalog_name: env-xyz123
database_name: lkc-xyz123
options:
result_format: ARROW_STREAM
query: SELECT l_orderkey, l_quantity, l_description FROM "order" LIMIT 5
responses:
'200':
description: 'Successful synchronous response containing fully inlined metadata and data results.
'
headers:
X-Request-Id:
description: Unique identifier for this request, useful for support and debugging
schema:
type: string
content:
application/json:
schema:
type: object
description: Response structure returned directly for fast inline extractions.
required:
- api_version
- kind
- result
properties:
api_version:
type: string
readOnly: true
description: APIVersion defines the schema version of this representation of a resource.
enum:
- query/v1alpha1
kind:
type: string
readOnly: true
description: Kind defines the object this REST resource represents.
enum:
- Statement
result:
description: The schema and data produced by the statement.
allOf:
- type: object
description: 'Query result containing schema metadata and row data.
This envelope is the same for every statement kind. `SHOW` and `DESCRIBE` return
declared column types in `schema` and string-encoded values in `data` exactly
as `SELECT` does, so a client needs only one result reader and never has to branch
on the statement it sent.
'
required:
- result_format
- schema
- data
properties:
result_format:
type: string
readOnly: true
description: 'Encoding of `data`, echoing the `options.result_format` requested
on the statement.
'
enum:
- JSON
- ARROW_STREAM
schema:
description: Column metadata describing the shape of the returned rows.
allOf:
- type: object
description: The table columns of the result schema.
required:
- columns
properties:
columns:
type: array
description: 'Column definitions in result order, matching the order of
values within each row.
'
items:
type: object
description: A column in the result schema.
required:
- name
- type
properties:
name:
type: string
description: The name of the SQL result column.
type:
description: The logical type of the column.
allOf:
- type: object
required:
- type
- nullable
description: 'Flink logical type descriptor, mirroring `DataType`
in the Flink Gateway API.
Complex types nest recursively: `elementType`, `keyType`, `valueType`
and
`fields[].fieldType` are themselves `DataType` objects, so `ROW`,
`ARRAY`,
`MAP` and `MULTISET` nest to arbitrary depth.
The value of `type` determines which parameter properties are
present; all
others are absent.
| `type` | Parameters |
| --- | --- |
| `BOOLEAN`, `TINYINT`, `SMALLINT`, `INTEGER`, `BIGINT`, `FLOAT`,
`DOUBLE`, `DATE`, `NULL` | none |
| `CHAR`, `VARCHAR`, `BINARY`, `VARBINARY` | `length` |
| `DECIMAL` | `precision`, `scale` |
| `TIME_WITHOUT_TIME_ZONE`, `TIMESTAMP_WITHOUT_TIME_ZONE`, `TIMESTAMP_WITH_TIME_ZONE`
| `precision` |
| `INTERVAL_YEAR_MONTH` | `precision`, `resolution` |
| `INTERVAL_DAY_TIME` | `precision`, `fractionalPrecision`,
`resolution` |
| `ARRAY`, `MULTISET` | `elementType` |
| `MAP` | `keyType`, `valueType` |
| `ROW` | `fields` |
'
properties:
type:
type: string
description: The Flink logical type name of the column or
field.
nullable:
type: boolean
description: Whether values of this column or field can be
null.
length:
type: integer
format: int32
description: 'Declared length of `CHAR`, `VARCHAR`, `BINARY`
and `VARBINARY`. Unbounded `VARCHAR` and `VARBINARY` report
2147483647.
'
precision:
type: integer
format: int32
description: 'Declared precision of `DECIMAL`, the `TIME`/`TIMESTAMP`
types and the `INTERVAL_*` types.
'
scale:
type: integer
format: int32
description: Declared scale of `DECIMAL`.
keyType:
description: Key type of a `MAP`.
allOf:
- circular(query.v1alpha1.DataType)
valueType:
description: Value type of a `MAP`.
allOf:
- circular(query.v1alpha1.DataType)
elementType:
description: Element type of an `ARRAY` or `MULTISET`.
allOf:
- circular(query.v1alpha1.DataType)
fields:
type: array
description: Fields of a `ROW`, in declaration order.
items:
type: object
required:
- name
- fieldType
description: 'One field of a `ROW`. Field names are carried
here, in the schema only — never inline with the row values.
'
properties:
name:
type: string
description: The name of the field.
fieldType:
description: The data type of the field.
allOf:
- circular(query.v1alpha1.DataType)
description:
type: string
description: Optional field comment from the type declaration.
title: query.v1alpha1.RowFieldType
resolution:
type: string
description: 'Interval resolution, for example `YEAR_TO_MONTH`
for `INTERVAL_YEAR_MONTH` or `DAY_TO_SECOND` for `INTERVAL_DAY_TIME`.
'
fractionalPrecision:
type: integer
format: int32
description: Fractional-second precision of `INTERVAL_DAY_TIME`.
class_name:
type: string
description: 'Class name of a structured type. Present in
the Flink type model; the engine does not currently emit
structured types.
'
title: query.v1alpha1.DataType
title: query.v1alpha1.ColumnDetails
title: query.v1alpha1.ResultSchema
data:
description: 'Result rows in the encoding named by `result_format`: an array
of rows for `JSON`, where each row is a positional array of column values
ordered to match `schema.columns`; or a base64-encoded Arrow IPC stream for
`ARROW_STREAM`, carrying native column types rather than stringified values.
Inline Arrow payloads are size-capped by the service; larger results are delivered
through the asynchronous 202 flow.
Under `JSON`, individual values — including those of complex `ROW`, `ARRAY`,
`MAP` and `MULTISET` columns — are encoded as described by `ResultValue`.
'
oneOf:
- type: array
items:
type: array
description: 'A single result row — column values ordered to match `schema.columns`.
Rows carry no changelog operation marker: this API returns a point-in-time
snapshot rather than a changelog stream, so there are no retractions to
express.
'
items:
description: "One value within a `JSON` result row.\n\nScalar values are\
\ JSON strings encoded according to the declaring column's\n`DataType.type`.\
\ JSON `null` is SQL NULL, at any depth.\n\nComplex values are JSON\
\ arrays whose elements are themselves `ResultValue`s:\n\n- `ROW` —\
\ a positional array with one element per entry of the type's `fields`,\n\
\ in the same order. Field names are never repeated inline; recovering\
\ them\n requires the schema.\n- `ARRAY` — one element per collection\
\ element, in order.\n- `MAP` and `MULTISET` — an array of two-element\
\ `[key, value]` arrays.\n\nA complex value that is itself SQL NULL\
\ is JSON `null`, which is distinct from\nan array whose elements are\
\ null.\n\nCanonical scalar encodings:\n\n| `DataType.type` | Encoding\
\ |\n| --- | --- |\n| `NULL` | JSON `null` |\n| `BOOLEAN` | `\"TRUE\"\
` or `\"FALSE\"`, upper case |\n| `TINYINT`, `SMALLINT`, `INTEGER`,\
\ `BIGINT` | base-10 integer string, optional leading `-` |\n| `FLOAT`,\
\ `DOUBLE` | shortest round-trip decimal string, in exponent notation\
\ where Java would use it |\n| `DECIMAL` | plain decimal string with\
\ exactly `scale` fractional digits, no exponent |\n| `CHAR`, `VARCHAR`\
\ | the string value verbatim, UTF-8 |\n| `BINARY`, `VARBINARY` | hexadecimal\
\ literal, for example `\"x'7f0203'\"` |\n| `DATE` | `YYYY-MM-DD` |\n\
| `TIME_WITHOUT_TIME_ZONE` | `HH:MM:SS[.fff]` |\n| `TIMESTAMP_WITHOUT_TIME_ZONE`\
\ | `YYYY-MM-DD HH:MM:SS[.fff]`, space separated |\n| `TIMESTAMP_WITH_TIME_ZONE`\
\ | `YYYY-MM-DD HH:MM:SS[.fff]`, rendered in UTC. Flink's `TIMESTAMP_LTZ`\
\ is reported under this name; the instant is stored as UTC and the\
\ zone is metadata only, so no offset is emitted |\n| `INTERVAL_YEAR_MONTH`\
\ | `+YYYY-MM` |\n| `INTERVAL_DAY_TIME` | `+D HH:MM:SS.fff` |\n\nThese\
\ render SQL values, not API datetime or numeric fields — each format\
\ follows\nthe column's declared SQL type and matches Confluent Flink's\
\ documented value\nencodings, so one decoder serves both surfaces.\
\ `TIMESTAMP` therefore uses a space\nseparator rather than RFC 3339's\
\ `T`.\n\nThese encodings apply only when `result_format` is `JSON`.\
\ Under\n`ARROW_STREAM` values are carried natively, with `ROW` mapping\
\ to an Arrow\nstruct, `ARRAY` and `MULTISET` to a list, and `MAP` to\
\ a map.\n"
anyOf:
- type: string
nullable: true
- type: array
nullable: true
items: circular(query.v1alpha1.ResultValue)
title: query.v1alpha1.ResultValue
title: query.v1alpha1.ResultRow
- type: string
format: byte
title: query.v1alpha1.QueryResult
title: query.v1alpha1.QueryResponseInline
examples:
select_with_limit:
summary: Inline Query Execution Result
value:
api_version: query/v1alpha1
kind: Statement
result:
result_format: JSON
schema:
columns:
- name: L_ORDERKEY
type:
nullable: true
type: BIGINT
- name: L_QUANTITY
type:
nullable: true
type: FLOAT
data:
- - '1'
- '17.45'
select_nested:
summary: Inline Query Execution Result (complex columns)
description: '`ROW`, `ARRAY`, `MAP` and `MULTISET` columns describe their structure
in `schema` and carry their values as nested JSON arrays. Values are positional at
every level: names appear only in the schema. The second row shows a SQL NULL `ARRAY`
and an empty `MAP`.
'
value:
api_version: query/v1alpha1
kind: Statement
result:
result_format: JSON
schema:
columns:
- name: PK
type:
nullable: false
type: BIGINT
- name: user
type:
nullable: false
type: ROW
fields:
- name: USER_ID
fieldType:
nullable: false
type: VARCHAR
length: 2147483647
- name: AGE
fieldType:
nullable: false
type: INTEGER
- name: tags
type:
nullable: true
type: ARRAY
elementType:
nullable: true
type: VARCHAR
length: 2147483647
- name: scores
type:
nullable: true
type: MAP
keyType:
nullable: false
type: VARCHAR
length: 2147483647
valueType:
nullable: true
type: INTEGER
data:
- - '912'
- - perspiciatis
- '49'
- - pro
- null
- - - latency
- '42'
- - '27994'
- - suscipit
- '25'
- null
- []
describe_table:
summary: Inline Query Execution Result (DESCRIBE)
description: '`SHOW` and `DESCRIBE` use the same envelope as `SELECT`, with declared
column types and every value encoded as a string. Note `"TRUE"` for the `null` column,
which is declared `BOOLEAN`.
'
value:
api_version: query/v1alpha1
kind: Statement
result:
result_format: JSON
schema:
columns:
- name: name
type:
nullable: true
type: VARCHAR
length: 2147483647
- name: type
type:
nullable: true
type: VARCHAR
length: 2147483647
- name: 'null'
type:
nullable: false
type: BOOLEAN
- name: key
type:
nullable: true
type: VARCHAR
length: 2147483647
- name: extras
type:
nullable: true
type: VARCHAR
length: 2147483647
- name: watermark
type:
nullable: true
type: VARCHAR
length: 2147483647
data:
- - KEY
- BYTES
- 'TRUE'
- null
- null
- null
- - PK
- BIGINT
- 'FALSE'
- null
- null
- null
- - user
- ROW<`USER_ID` STRING, `AGE` INT>
- 'FALSE'
- null
- null
- null
select_with_limit_arrow:
summary: Inline Query Execution Result (Arrow)
description: 'Returned when the statement requested `result_format: ARROW_STREAM`. Rows
are carried as a base64-encoded Arrow IPC stream with native column types; `schema`
still describes the columns so clients can inspect the result without decoding the
payload.
'
value:
api_version: query/v1alpha1
kind: Statement
result:
result_format: ARROW_STREAM
schema:
columns:
- name: L_ORDERKEY
type:
nullable: true
type: BIGINT
- name: L_QUANTITY
type:
nullable: true
type: FLOAT
data: /////0FSUk9XLUlQQy1TVFJFQU0tUExBQ0VIT0xERVItQllURVM=
'202':
description: 'Asynchronous request registration. Returned when data sets exceed 25 MiB or execution
times cross the 30s processing barrier.
'
headers:
X-Request-Id:
description: Unique identifier for this request, useful for support and debugging
schema:
type: string
Location:
description: Complete URL path indicating where the client can poll for state changes.
schema:
type: string
format: uri
content:
application/json:
schema:
type: object
description: Reference pointers issued when standard executions run asynchronously.
required:
- statement_id
- result_url
properties:
statement_id:
type: string
maxLength: 255
description: Unique identifier generated to trace the decoupled tracking process.
result_url:
type: string
format: uri
description: The streaming data target location where finished row sets can be downloaded.
title: query.v1alpha1.QueryResponseAsync
examples:
async_redirect:
summary: Async Job Reference Output
value:
statement_id: statement_1b2c3d4e5f6a
result_url: https://sql.region.provider.confluent.cloud/query/v1alpha1/jobs/statement_1b2c3d4e5f6a/results
'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://sql.region.provider.confluent.cloud
description: SQL Endpoint through Analytics Gateway
jsonRequestBodyExample:
catalog_name: string
database_name: string
options:
max_result_rows: 0
result_format: JSON
query: string
client_info: {}