List of Private Link Attachment Connections
GET/networking/v1/private-link-attachment-connections
Retrieve a sorted, filtered, paginated list of all private link attachment connections.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Private Link Attachment Connection.
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:
/networking/v1/private-link-attachment-connections:
get:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: listNetworkingV1PrivateLinkAttachmentConnections
description: '[](#section/Versioning/API-Lifecycle-Policy)
Retrieve a sorted, filtered, paginated list of all private link attachment connections.'
parameters:
- 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.private_link_attachment
in: query
required: false
schema:
description: Filter a collection by a string search
type: string
title: SearchFilter
example: platt-00000
description: Filter the results by exact match for spec.private_link_attachment.
- 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:
- Private Link Attachment Connections (networking/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
responses:
'200':
description: Private Link Attachment Connection.
content:
application/json:
schema:
allOf:
- type: object
description: 'PrivateLink attachment connection objects represent connections established
to a cloud region
in order to access resources that belong to a Confluent Cloud Environment.
The API allows you to list, create, read update and delete your PrivateLink attachment
connections.
## The Private Link Attachment Connections Model
<SchemaDefinition schemaRef="#/components/schemas/networking.v1.PrivateLinkAttachmentConnection"
/>'
required:
- api_version
- kind
- metadata
- data
properties:
api_version:
type: string
enum:
- networking/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:
- PrivateLinkAttachmentConnectionList
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/networking/v1/private-link-attachment-connections
last:
example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections?page_token=bcAOehAY8F16YD84Z1wT
prev:
example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections?page_token=YIXRY97wWYmwzrax4dld
next:
example: https://api.confluent.cloud/networking/v1/private-link-attachment-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: 'PrivateLink attachment connection objects represent connections
established to a cloud region
in order to access resources that belong to a Confluent Cloud Environment.
The API allows you to list, create, read update and delete your PrivateLink
attachment connections.
## The Private Link Attachment Connections Model
<SchemaDefinition schemaRef="#/components/schemas/networking.v1.PrivateLinkAttachmentConnection"
/>'
properties:
api_version:
type: string
enum:
- networking/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:
- PrivateLinkAttachmentConnection
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/networking/v1/private-link-attachment-connections/plattc-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment-connection=plattc-12345
spec:
type: object
description: The desired state of the Private Link Attachment Connection
properties:
display_name:
type: string
description: The name of the PrivateLink attachment connection.
example: prod-gcp-us-central1-a
cloud:
type: object
description: The cloud-specific PrivateLink attachment connection details.
oneOf:
- description: Represents a connection between an AWS VPC Endpoint and
an Endpoint service.
type: object
required:
- kind
- vpc_endpoint_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnection kind.
enum:
- AwsPrivateLinkAttachmentConnection
vpc_endpoint_id:
description: Id of a VPC Endpoint that is connected to the VPC
Endpoint service.
type: string
minLength: 1
example: vpce-00000000000000000
title: networking.v1.AwsPrivateLinkAttachmentConnection
- description: Represents a connection between an Azure PrivateLink
service and a PrivateEndpoint.
type: object
required:
- kind
- private_endpoint_resource_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnection kind.
enum:
- AzurePrivateLinkAttachmentConnection
private_endpoint_resource_id:
description: 'Resource Id of the PrivateEndpoint that is connected
to the PrivateLink service.
'
type: string
minLength: 1
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3
title: networking.v1.AzurePrivateLinkAttachmentConnection
- type: object
description: Represents a connection between a GCP PSC Service Attachment
and a PSC Endpoint.
required:
- kind
- private_service_connect_connection_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnection kind.
enum:
- GcpPrivateLinkAttachmentConnection
private_service_connect_connection_id:
description: Id of the Private Service connection.
type: string
minLength: 1
example: '00000000000000000'
title: networking.v1.GcpPrivateLinkAttachmentConnection
discriminator:
propertyName: kind
mapping:
AwsPrivateLinkAttachmentConnection:
description: Represents a connection between an AWS VPC Endpoint
and an Endpoint service.
type: object
required:
- kind
- vpc_endpoint_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnection kind.
enum:
- AwsPrivateLinkAttachmentConnection
vpc_endpoint_id:
description: Id of a VPC Endpoint that is connected to the
VPC Endpoint service.
type: string
minLength: 1
example: vpce-00000000000000000
title: networking.v1.AwsPrivateLinkAttachmentConnection
AzurePrivateLinkAttachmentConnection:
description: Represents a connection between an Azure PrivateLink
service and a PrivateEndpoint.
type: object
required:
- kind
- private_endpoint_resource_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnection kind.
enum:
- AzurePrivateLinkAttachmentConnection
private_endpoint_resource_id:
description: 'Resource Id of the PrivateEndpoint that is connected
to the PrivateLink service.
'
type: string
minLength: 1
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3
title: networking.v1.AzurePrivateLinkAttachmentConnection
GcpPrivateLinkAttachmentConnection:
type: object
description: Represents a connection between a GCP PSC Service
Attachment and a PSC Endpoint.
required:
- kind
- private_service_connect_connection_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnection kind.
enum:
- GcpPrivateLinkAttachmentConnection
private_service_connect_connection_id:
description: Id of the Private Service connection.
type: string
minLength: 1
example: '00000000000000000'
title: networking.v1.GcpPrivateLinkAttachmentConnection
x-immutable: true
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
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
api_version:
type: string
description: API group and version of the referred resource
minLength: 1
readOnly: true
kind:
type: string
description: Kind of the referred resource
minLength: 1
readOnly: true
title: ObjectReference
description: The environment to which this belongs.
private_link_attachment:
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
api_version:
type: string
description: API group and version of the referred resource
minLength: 1
readOnly: true
kind:
type: string
description: Kind of the referred resource
minLength: 1
readOnly: true
title: ObjectReference
description: The private_link_attachment to which this belongs.
x-immutable: true
x-enable-id: true
x-enable-listmeta: true
x-enable-objectmeta: true
title: networking.v1.PrivateLinkAttachmentConnectionSpec
status:
type: object
required:
- phase
description: The status of the Private Link Attachment Connection
properties:
phase:
type: string
description: "The lifecycle phase of the PrivateLink attachment:\n\n\
\ PROVISIONING: PrivateLink attachment connection provisioning is\
\ in progress;\n\n READY: PrivateLink attachment connection is ready;\n\
\n FAILED: PrivateLink attachment connection is in a failed state;\n\
\n DEPROVISIONING: PrivateLink attachment connection deprovisioning\
\ is in progress;\n\n DISCONNECTED:|\n PrivateLink attachment\
\ connection is in a disconnected state. This means the\n private\
\ endpoint associated with this PrivateLink attachment connection\
\ has been deleted;\n"
readOnly: true
example: READY
enum:
- PROVISIONING
- READY
- FAILED
- DEPROVISIONING
- DISCONNECTED
error_code:
type: string
description: Error code if PrivateLink attachment connection is in a
failed state. May be used for programmatic error checking.
readOnly: true
error_message:
type: string
description: Displayable error message if PrivateLink attachment connection
is in a failed state.
readOnly: true
cloud:
type: object
description: The cloud specific status of the PrivateLink attachment
connection.
oneOf:
- description: Status of a connection to an AWS PrivateLink attachment.
type: object
required:
- kind
- vpc_endpoint_service_name
- vpc_endpoint_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnectionStatus kind.
enum:
- AwsPrivateLinkAttachmentConnectionStatus
vpc_endpoint_service_name:
description: Id of the VPC Endpoint service used for PrivateLink.
type: string
minLength: 1
example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000
readOnly: true
vpc_endpoint_id:
description: Id of the VPC Endpoint (if any) that is connected
to the VPC Endpoint service.
type: string
minLength: 1
readOnly: true
example: vpce-00000000000000000
title: networking.v1.AwsPrivateLinkAttachmentConnectionStatus
- description: Status of a Azure PrivateLink attachment connection.
type: object
required:
- kind
- private_link_service_alias
- private_link_service_resource_id
- private_endpoint_resource_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnectionStatus kind.
enum:
- AzurePrivateLinkAttachmentConnectionStatus
private_link_service_alias:
description: Azure PrivateLink service alias.
type: string
minLength: 1
readOnly: true
example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice
private_link_service_resource_id:
description: Azure PrivateLink service resource id.
type: string
minLength: 1
readOnly: true
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3
private_endpoint_resource_id:
description: 'Resource Id of the PrivateEndpoint (if any) that
is connected to
the PrivateLink service.
'
type: string
minLength: 1
readOnly: true
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3
title: networking.v1.AzurePrivateLinkAttachmentConnectionStatus
- description: Status of GCP PrivateLink attachment connection.
type: object
required:
- kind
- private_service_connect_service_attachment
- private_service_connect_connection_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnectionStatus kind.
enum:
- GcpPrivateLinkAttachmentConnectionStatus
private_service_connect_service_attachment:
description: GCP Private Service Connect ServiceAttachment.
type: string
minLength: 1
readOnly: true
example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1-a
private_service_connect_connection_id:
description: Id of the Private Service connection.
type: string
minLength: 1
readOnly: true
example: '00000000000000000'
title: networking.v1.GcpPrivateLinkAttachmentConnectionStatus
discriminator:
propertyName: kind
mapping:
AwsPrivateLinkAttachmentConnectionStatus:
description: Status of a connection to an AWS PrivateLink attachment.
type: object
required:
- kind
- vpc_endpoint_service_name
- vpc_endpoint_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnectionStatus kind.
enum:
- AwsPrivateLinkAttachmentConnectionStatus
vpc_endpoint_service_name:
description: Id of the VPC Endpoint service used for PrivateLink.
type: string
minLength: 1
example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000
readOnly: true
vpc_endpoint_id:
description: Id of the VPC Endpoint (if any) that is connected
to the VPC Endpoint service.
type: string
minLength: 1
readOnly: true
example: vpce-00000000000000000
title: networking.v1.AwsPrivateLinkAttachmentConnectionStatus
AzurePrivateLinkAttachmentConnectionStatus:
description: Status of a Azure PrivateLink attachment connection.
type: object
required:
- kind
- private_link_service_alias
- private_link_service_resource_id
- private_endpoint_resource_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnectionStatus kind.
enum:
- AzurePrivateLinkAttachmentConnectionStatus
private_link_service_alias:
description: Azure PrivateLink service alias.
type: string
minLength: 1
readOnly: true
example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice
private_link_service_resource_id:
description: Azure PrivateLink service resource id.
type: string
minLength: 1
readOnly: true
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3
private_endpoint_resource_id:
description: 'Resource Id of the PrivateEndpoint (if any)
that is connected to
the PrivateLink service.
'
type: string
minLength: 1
readOnly: true
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3
title: networking.v1.AzurePrivateLinkAttachmentConnectionStatus
GcpPrivateLinkAttachmentConnectionStatus:
description: Status of GCP PrivateLink attachment connection.
type: object
required:
- kind
- private_service_connect_service_attachment
- private_service_connect_connection_id
properties:
kind:
type: string
description: PrivateLinkAttachmentConnectionStatus kind.
enum:
- GcpPrivateLinkAttachmentConnectionStatus
private_service_connect_service_attachment:
description: GCP Private Service Connect ServiceAttachment.
type: string
minLength: 1
readOnly: true
example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1-a
private_service_connect_connection_id:
description: Id of the Private Service connection.
type: string
minLength: 1
readOnly: true
example: '00000000000000000'
title: networking.v1.GcpPrivateLinkAttachmentConnectionStatus
readOnly: true
readOnly: true
title: networking.v1.PrivateLinkAttachmentConnectionStatus
title: networking.v1.PrivateLinkAttachmentConnection
- type: object
required:
- id
- metadata
- spec
- status
properties:
spec:
type: object
required:
- cloud
- environment
- private_link_attachment
uniqueItems: true
title: networking.v1.PrivateLinkAttachmentConnectionList
- type: object
properties:
data:
type: array
items:
properties:
spec:
type: object
properties:
environment:
example:
id: env-00000
related: https://api.confluent.cloud/v2/environments/env-00000
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000
private_link_attachment:
example:
id: platt-00000
related: https://api.confluent.cloud/networking/v1/private-link-attachments/platt-00000
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment=platt-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