List of Peerings
GET/networking/v1/peerings
Retrieve a sorted, filtered, paginated list of all peerings.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Peering.
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/peerings:
get:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: listNetworkingV1Peerings
description: '[](#section/Versioning/API-Lifecycle-Policy)
Retrieve a sorted, filtered, paginated list of all peerings.'
parameters:
- name: spec.display_name
in: query
required: false
schema:
description: Filter a collection by a string search for one or more values
type: array
items:
type: string
title: MultipleSearchFilter
example:
- prod-peering-uscentral1
- prod-peering-use1
description: Filter the results by exact match for spec.display_name. Pass multiple times to see
results matching any of the values.
style: form
explode: true
- name: status.phase
in: query
required: false
schema:
description: Filter a collection by a string search for one or more values
type: array
items:
type: string
title: MultipleSearchFilter
example:
- PROVISIONING
- READY
description: Filter the results by exact match for status.phase. Pass multiple times to see results
matching any of the values.
style: form
explode: true
- name: environment
in: query
required: true
schema:
description: Filter a collection by a string search
type: string
title: SearchFilter
example: env-00000
description: Filter the results by exact match for environment.
- name: spec.network
in: query
required: false
schema:
description: Filter a collection by a string search for one or more values
type: array
items:
type: string
title: MultipleSearchFilter
example:
- n-00000
- n-00001
description: Filter the results by exact match for spec.network. Pass multiple times to see results
matching any of the values.
style: form
explode: true
- name: page_size
in: query
required: false
schema:
type: integer
default: 10
maximum: 1000
x-max-page-items: 1000
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:
- Peerings (networking/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
responses:
'200':
description: Peering.
content:
application/json:
schema:
allOf:
- type: object
description: 'Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent
Cloud.
Related guides:
* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).
* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).
* [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html).
## The Peerings Model
<SchemaDefinition schemaRef="#/components/schemas/networking.v1.Peering" />
## Quotas and Limits
This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):
| Quota | Description |
| --- | --- |
| `peerings_per_network` | Number of peerings per network |'
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:
- PeeringList
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/peerings
last:
example: https://api.confluent.cloud/networking/v1/peerings?page_token=bcAOehAY8F16YD84Z1wT
prev:
example: https://api.confluent.cloud/networking/v1/peerings?page_token=YIXRY97wWYmwzrax4dld
next:
example: https://api.confluent.cloud/networking/v1/peerings?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: 'Add or remove VPC/VNet peering connections between your VPC/VNet
and Confluent Cloud.
Related guides:
* [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html).
* [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html).
* [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html).
## The Peerings Model
<SchemaDefinition schemaRef="#/components/schemas/networking.v1.Peering" />
## Quotas and Limits
This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):
| Quota | Description |
| --- | --- |
| `peerings_per_network` | Number of peerings per network |'
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:
- Peering
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/peerings/p-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/peering=p-12345
spec:
type: object
description: The desired state of the Peering
properties:
display_name:
type: string
description: The name of the peering
example: prod-peering-use1
cloud:
type: object
oneOf:
- type: object
title: AWS
description: AWS VPC Peering.
required:
- kind
- account
- vpc
- routes
- customer_region
properties:
kind:
description: Peering kind type.
type: string
enum:
- AwsPeering
account:
type: string
pattern: ^\d{12}$
example: '000000000000'
description: The AWS account ID associated with the VPC you are
peering with Confluent Cloud network.
vpc:
type: string
minLength: 1
description: The VPC ID you are peering with Confluent Cloud network.
example: vpc-00000000000000000
routes:
type: array
items:
type: string
pattern: ^\d+\.\d+\.\d+\.\d+/\d+$
description: IPv4 CIDR block
example: 10.200.0.0/16
title: networking.v1.Cidr
description: 'The [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
of the VPC you are peering
with Confluent Cloud network. This is used by Confluent Cloud
network to route traffic back to your network.
The CIDR block must be a private range and cannot overlap with
the Confluent Cloud CIDR block.
'
example:
- 10.108.16.0/21
customer_region:
type: string
description: The region of the VPC you are peering with Confluent
Cloud network.
example: us-east-1
- type: object
title: GCP
description: GCP VPC Peering.
required:
- kind
- project
- vpc_network
properties:
kind:
description: Peering kind type.
type: string
enum:
- GcpPeering
example: GcpPeering
project:
type: string
minLength: 1
description: 'The Google Cloud project ID associated with the
VPC that you are peering with Confluent Cloud network.
'
example: my-gcp-project
vpc_network:
type: string
minLength: 1
description: The name of the VPC that you are peering with Confluent
Cloud network.
example: my-gcp-network
import_custom_routes:
type: boolean
description: 'Enable customer route import. For more information,
see
[Importing custom routes](https://cloud.google.com/vpc/docs/vpc-peering#importing-exporting-routes).
'
example: true
default: false
- type: object
title: AZURE
description: Azure VNet Peering.
required:
- kind
- tenant
- vnet
- customer_region
properties:
kind:
description: Peering kind type.
type: string
enum:
- AzurePeering
tenant:
type: string
minLength: 1
description: 'The Azure Tenant ID in which your Azure Subscription
exists.
Represents an organization in Azure Active Directory. You can
find your Azure Tenant ID in the Azure Portal
under
[Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview).
Must be a valid **32 character UUID string**.
'
vnet:
type: string
minLength: 1
description: The resource ID of the VNet that you are peering
with Confluent Cloud. You can find the name of your Azure VNet
in the [Azure Portal on the Overview tab of your Azure Virtual
Network](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Network%2FvirtualNetworks).
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet
customer_region:
type: string
description: The region of the VNet you are peering with Confluent
Cloud network.
example: eastus2
discriminator:
propertyName: kind
mapping:
AwsPeering:
type: object
title: AWS
description: AWS VPC Peering.
required:
- kind
- account
- vpc
- routes
- customer_region
properties:
kind:
description: Peering kind type.
type: string
enum:
- AwsPeering
account:
type: string
pattern: ^\d{12}$
example: '000000000000'
description: The AWS account ID associated with the VPC you
are peering with Confluent Cloud network.
vpc:
type: string
minLength: 1
description: The VPC ID you are peering with Confluent Cloud
network.
example: vpc-00000000000000000
routes:
type: array
items:
type: string
pattern: ^\d+\.\d+\.\d+\.\d+/\d+$
description: IPv4 CIDR block
example: 10.200.0.0/16
title: networking.v1.Cidr
description: 'The [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
of the VPC you are peering
with Confluent Cloud network. This is used by Confluent
Cloud network to route traffic back to your network.
The CIDR block must be a private range and cannot overlap
with the Confluent Cloud CIDR block.
'
example:
- 10.108.16.0/21
customer_region:
type: string
description: The region of the VPC you are peering with Confluent
Cloud network.
example: us-east-1
GcpPeering:
type: object
title: GCP
description: GCP VPC Peering.
required:
- kind
- project
- vpc_network
properties:
kind:
description: Peering kind type.
type: string
enum:
- GcpPeering
example: GcpPeering
project:
type: string
minLength: 1
description: 'The Google Cloud project ID associated with
the VPC that you are peering with Confluent Cloud network.
'
example: my-gcp-project
vpc_network:
type: string
minLength: 1
description: The name of the VPC that you are peering with
Confluent Cloud network.
example: my-gcp-network
import_custom_routes:
type: boolean
description: 'Enable customer route import. For more information,
see
[Importing custom routes](https://cloud.google.com/vpc/docs/vpc-peering#importing-exporting-routes).
'
example: true
default: false
AzurePeering:
type: object
title: AZURE
description: Azure VNet Peering.
required:
- kind
- tenant
- vnet
- customer_region
properties:
kind:
description: Peering kind type.
type: string
enum:
- AzurePeering
tenant:
type: string
minLength: 1
description: 'The Azure Tenant ID in which your Azure Subscription
exists.
Represents an organization in Azure Active Directory. You
can find your Azure Tenant ID in the Azure Portal
under
[Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview).
Must be a valid **32 character UUID string**.
'
vnet:
type: string
minLength: 1
description: The resource ID of the VNet that you are peering
with Confluent Cloud. You can find the name of your Azure
VNet in the [Azure Portal on the Overview tab of your Azure
Virtual Network](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Network%2FvirtualNetworks).
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet
customer_region:
type: string
description: The region of the VNet you are peering with Confluent
Cloud network.
example: eastus2
description: The cloud-specific peering details.
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.
network:
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 network to which this belongs.
x-immutable: true
x-enable-id: true
x-enable-listmeta: true
x-enable-objectmeta: true
title: networking.v1.PeeringSpec
status:
type: object
required:
- phase
description: The status of the Peering
properties:
phase:
type: string
description: "The lifecycle phase of the peering:\n\n PROVISIONING:\
\ peering provisioning is in progress;\n\n PENDING_ACCEPT: peering\
\ connection request is pending acceptance by the customer;\n\n READY:\
\ peering is ready;\n\n FAILED: peering is in a failed state;\n\n\
\ DEPROVISIONING: peering deprovisioning is in progress;\n\n DISCONNECTED:\
\ peering has been disconnected in the cloud provider by the customer;\n"
readOnly: true
example: READY
enum:
- PROVISIONING
- PENDING_ACCEPT
- READY
- FAILED
- DEPROVISIONING
- DISCONNECTED
error_code:
type: string
description: Error code if peering is in a failed state. May be used
for programmatic error checking.
readOnly: true
error_message:
type: string
description: Displayable error message if peering is in a failed state
readOnly: true
readOnly: true
title: networking.v1.PeeringStatus
title: networking.v1.Peering
- type: object
required:
- id
- metadata
- spec
- status
properties:
spec:
type: object
required:
- cloud
- environment
- network
uniqueItems: true
title: networking.v1.PeeringList
- 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
network:
example:
id: n-00000
related: https://api.confluent.cloud/networking/v1/networks/n-00000
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-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