Update a Network
PATCH/networking/v1/networks/:id
Make a request to update a network.
Request
Responses
- 200
- 400
- 401
- 402
- 403
- 404
- 409
- 422
- 429
- 500
Network.
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 request would exceed one or more quotas.
Response Headers
X-Request-Id
The unique identifier for the API request.
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.
The request is in conflict with the current server state
Response Headers
X-Request-Id
The unique identifier for the API request.
Location
Resource URI of conflicting resource
Validation Failed
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/networks/{id}:
patch:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: updateNetworkingV1Network
description: '[](#section/Versioning/API-Lifecycle-Policy)
Make a request to update a network.
'
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The unique identifier for the network.
tags:
- Networks (networking/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
requestBody:
content:
application/json:
schema:
allOf:
- type: object
description: '`Network` represents a network (VPC) in Confluent Cloud. All Networks exist
within Confluent-managed cloud
provider accounts. Dedicated networks support more networking options but can only contain
Dedicated clusters.
Shared networks can contain any cluster type.
The API allows you to list, create, read, update, and delete your networks.
Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html).
## The Networks Model
<SchemaDefinition schemaRef="#/components/schemas/networking.v1.Network" />
## Quotas and Limits
This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):
| Quota | Description |
| --- | --- |
| `dedicated_networks_per_environment` | Number of dedicated networks per Confluent
Cloud environment |'
properties:
metadata:
allOf:
- description: ObjectMeta is metadata that all persisted resources must have, which
includes all objects users must create.
properties: {}
readOnly: true
title: ObjectMeta
- properties:
self:
example: https://api.confluent.cloud/networking/v1/networks/n-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-12345
spec:
type: object
description: The desired state of the Network
properties:
display_name:
type: string
description: The name of the network
example: prod-aws-us-east1
environment:
allOf:
- type: object
description: ObjectReference provides information for you to locate the referred
object
required:
- id
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
title: ObjectReference
description: The environment to which this belongs.
x-enable-id: true
x-enable-listmeta: true
x-enable-objectmeta: true
title: networking.v1.NetworkSpec
title: networking.v1.Network
- type: object
required:
- spec
properties:
spec:
type: object
required:
- environment
properties:
environment:
example:
id: env-00000
responses:
'200':
description: Network.
content:
application/json:
schema:
allOf:
- type: object
description: '`Network` represents a network (VPC) in Confluent Cloud. All Networks
exist within Confluent-managed cloud
provider accounts. Dedicated networks support more networking options but can only
contain Dedicated clusters.
Shared networks can contain any cluster type.
The API allows you to list, create, read, update, and delete your networks.
Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html).
## The Networks Model
<SchemaDefinition schemaRef="#/components/schemas/networking.v1.Network" />
## Quotas and Limits
This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):
| Quota | Description |
| --- | --- |
| `dedicated_networks_per_environment` | Number of dedicated networks per Confluent
Cloud environment |'
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:
- Network
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/networks/n-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-12345
spec:
type: object
description: The desired state of the Network
properties:
display_name:
type: string
description: The name of the network
example: prod-aws-us-east1
cloud:
type: string
description: The cloud service provider in which the network exists.
example: AWS
x-immutable: true
enum:
- AWS
- GCP
- AZURE
region:
type: string
description: The cloud service provider region in which the network exists.
example: us-east-1
x-immutable: true
connection_types:
type: array
description: The connection types requested for use with the network.
items:
type: string
description: Network connection type.
example: PRIVATELINK
enum:
- PEERING
- TRANSITGATEWAY
- PRIVATELINK
title: networking.v1.ConnectionType
uniqueItems: true
minItems: 1
x-immutable: true
cidr:
type: string
pattern: ^\d+\.\d+\.\d+\.\d+/\d+$
description: 'The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
to used for this network.
Must be `/16`. Required for VPC peering and AWS TransitGateway.
'
example: 10.200.0.0/16
x-immutable: true
zones:
type: array
items:
type: string
uniqueItems: true
minItems: 3
maxItems: 3
description: "The 3 availability zones for this network. They can optionally\
\ be specified for AWS networks\nused with PrivateLink, for GCP networks used\
\ with Private Service Connect, and for AWS and GCP\nnetworks used with Peering.\n\
Otherwise, they are automatically chosen by Confluent Cloud.\n\nOn AWS, zones\
\ are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n\
\ (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n\
\ (e.g. us-central1-c).\n\nOn Azure, zones are Confluent-chosen names (e.g.\
\ 1, 2, 3) since Azure does not\n have universal zone identifiers.\n"
example:
- use1-az1
- use1-az2
- use1-az3
x-immutable: true
zones_info:
type: array
minItems: 3
maxItems: 3
uniqueItems: true
items:
type: object
description: Cloud provider zone metadata.
properties:
zone_id:
description: Cloud provider zone id
type: string
example: use1-az3
cidr:
description: 'The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
to used for this network.
Must be a `/27`. Required for VPC peering and AWS TransitGateway.
'
type: string
example: 10.20.0.0/27
title: networking.v1.ZoneInfo
description: 'Each item represents information related to a single zone.
Note - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
'
x-immutable: true
dns_config:
description: "DNS config only applies to PrivateLink network connection type.\n\
\nWhen resolution is CHASED_PRIVATE, clusters in this network require both\
\ public and private DNS\n to resolve cluster endpoints.\n\nWhen resolution\
\ is PRIVATE, clusters in this network only require private DNS\n to resolve\
\ cluster endpoints.\n"
allOf:
- type: object
description: The network DNS config
required:
- resolution
properties:
resolution:
type: string
description: Network DNS resolution type.
enum:
- CHASED_PRIVATE
- PRIVATE
title: networking.v1.DnsConfig
x-immutable: true
reserved_cidr:
type: string
description: "The reserved CIDR config is used only by AWS networks with connection_types\
\ = Vpc_Peering or Transit_Gateway\n\nAn IPv4 [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\n\
\ reserved for Confluent Cloud Network. Must be \\24.\n If not specified,\
\ Confluent Cloud Network uses 172.20.255.0/24\n\nNote - The attribute is\
\ in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)\n"
example: 172.20.255.0/24
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.
gateway:
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: TypedEnvScopedObjectReference
nullable: true
description: The gateway associated with this object. The gateway can be one
of networking.v1.Gateway. May be `null` or omitted if not associated with
a gateway.
readOnly: true
x-enable-id: true
x-enable-listmeta: true
x-enable-objectmeta: true
title: networking.v1.NetworkSpec
status:
type: object
required:
- phase
- supported_connection_types
- active_connection_types
description: The status of the Network
properties:
phase:
type: string
description: 'The lifecyle phase of the network:
PROVISIONING: network provisioning is in progress;
READY: network is ready;
FAILED: provisioning failed;
DEPROVISIONING: network deprovisioning is in progress;
'
readOnly: true
example: READY
enum:
- PROVISIONING
- READY
- FAILED
- DEPROVISIONING
supported_connection_types:
type: array
description: The connection types this network supports.
items:
type: string
description: Network connection type.
example: PRIVATELINK
enum:
- PEERING
- TRANSITGATEWAY
- PRIVATELINK
title: networking.v1.ConnectionType
uniqueItems: true
minItems: 1
readOnly: true
active_connection_types:
type: array
description: The connection types requested for use with the network.
items:
type: string
description: Network connection type.
example: PRIVATELINK
enum:
- PEERING
- TRANSITGATEWAY
- PRIVATELINK
title: networking.v1.ConnectionType
uniqueItems: true
minItems: 1
readOnly: true
error_code:
type: string
description: Error code if network is in a failed state. May be used for programmatic
error checking.
readOnly: true
example: insufficient_capacity
error_message:
type: string
description: Displayable error message if network is in a failed state
readOnly: true
example: Could not provision cloud resources
dns_domain:
type: string
description: The root DNS domain for the network if applicable. Present on networks
that support PrivateLink.
example: 00000.us-east-1.aws.glb.confluent.cloud
readOnly: true
endpoint_suffix:
type: string
description: 'The endpoint suffix for the network, if applicable. Full service
endpoints can be constructed by appending
the service identifier to the beginning of the endpoint suffix. For example,
the Flink REST endpoint can be
constructed by adding "flink" - ''https://flink'' + ''endpoint_suffix''.
'
example: .00000.us-east-1.aws.glb.confluent.cloud
readOnly: true
zonal_subdomains:
type: object
additionalProperties:
type: string
description: 'The DNS subdomain for each zone. Present on networks that support
PrivateLink. Keys are zones and
values are DNS domains.
'
example:
use1-az1: use1-az1.00000.us-east-1.aws.confluent.cloud
use1-az4: use1-az4.00000.us-east-1.aws.confluent.cloud
use1-az5: use1-az5.00000.us-east-1.aws.confluent.cloud
readOnly: true
cloud:
type: object
oneOf:
- type: object
description: The AWS network details.
required:
- kind
- vpc
- account
properties:
kind:
description: Network kind type.
type: string
enum:
- AwsNetwork
vpc:
type: string
description: The Confluent Cloud VPC ID.
example: vpc-00000000000000000
readOnly: true
account:
type: string
description: The AWS account ID associated with the Confluent Cloud VPC.
example: '000000000000'
readOnly: true
private_link_endpoint_service:
type: string
description: The endpoint service of the Confluent Cloud VPC. (used for
PrivateLink) if available.
example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000
readOnly: true
title: networking.v1.AwsNetwork
- type: object
description: The GCP network details.
required:
- kind
- project
- vpc_network
properties:
kind:
description: Network kind type.
type: string
enum:
- GcpNetwork
project:
type: string
description: The GCP Project ID associated with the Confluent Cloud VPC.
example: cc-prod-3
readOnly: true
vpc_network:
type: string
description: The network name of the Confluent Cloud VPC.
example: prod-network
readOnly: true
private_service_connect_service_attachments:
type: object
description: 'The mapping of zones to Private Service Connect Service
Attachments if available. Keys are zones and values are
[GCP Private Service Connect Service
Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7)
'
additionalProperties:
type: string
example:
us-central1-a: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a
us-central1-b: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b
us-central1-c: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c
readOnly: true
title: networking.v1.GcpNetwork
- type: object
description: The Azure network details.
required:
- kind
- vnet
- subscription
properties:
kind:
description: Network kind type.
type: string
enum:
- AzureNetwork
vnet:
type: string
description: The resource ID of the Confluent Cloud VNet.
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-group/providers/Microsoft.Network/virtualNetworks/prod-network
readOnly: true
subscription:
type: string
description: The Azure Subscription ID associated with the Confluent Cloud
VPC.
example: 00000000-0000-0000-0000-000000000000
readOnly: true
private_link_service_aliases:
type: object
description: 'The mapping of zones to Private Link Service Aliases if
available. Keys are zones
and values are [Azure Private Link Service
Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service).
'
additionalProperties:
type: string
example:
'1': 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice
'2': 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice
'3': 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice
readOnly: true
private_link_service_resource_ids:
type: object
description: 'The mapping of zones to Private Link Service Resource IDs
if available. Keys are zones
and values are [Azure Private Link Service Resource
IDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service).
'
additionalProperties:
type: string
example:
'1': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-1
'2': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-2
'3': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-3
readOnly: true
title: networking.v1.AzureNetwork
description: The cloud-specific network details. These will be populated when
the network reaches the READY state.
discriminator:
propertyName: kind
mapping:
AwsNetwork:
type: object
description: The AWS network details.
required:
- kind
- vpc
- account
properties:
kind:
description: Network kind type.
type: string
enum:
- AwsNetwork
vpc:
type: string
description: The Confluent Cloud VPC ID.
example: vpc-00000000000000000
readOnly: true
account:
type: string
description: The AWS account ID associated with the Confluent Cloud
VPC.
example: '000000000000'
readOnly: true
private_link_endpoint_service:
type: string
description: The endpoint service of the Confluent Cloud VPC. (used
for PrivateLink) if available.
example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000
readOnly: true
title: networking.v1.AwsNetwork
GcpNetwork:
type: object
description: The GCP network details.
required:
- kind
- project
- vpc_network
properties:
kind:
description: Network kind type.
type: string
enum:
- GcpNetwork
project:
type: string
description: The GCP Project ID associated with the Confluent Cloud
VPC.
example: cc-prod-3
readOnly: true
vpc_network:
type: string
description: The network name of the Confluent Cloud VPC.
example: prod-network
readOnly: true
private_service_connect_service_attachments:
type: object
description: 'The mapping of zones to Private Service Connect Service
Attachments if available. Keys are zones and values are
[GCP Private Service Connect Service
Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7)
'
additionalProperties:
type: string
example:
us-central1-a: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a
us-central1-b: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b
us-central1-c: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c
readOnly: true
title: networking.v1.GcpNetwork
AzureNetwork:
type: object
description: The Azure network details.
required:
- kind
- vnet
- subscription
properties:
kind:
description: Network kind type.
type: string
enum:
- AzureNetwork
vnet:
type: string
description: The resource ID of the Confluent Cloud VNet.
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-group/providers/Microsoft.Network/virtualNetworks/prod-network
readOnly: true
subscription:
type: string
description: The Azure Subscription ID associated with the Confluent
Cloud VPC.
example: 00000000-0000-0000-0000-000000000000
readOnly: true
private_link_service_aliases:
type: object
description: 'The mapping of zones to Private Link Service Aliases
if available. Keys are zones
and values are [Azure Private Link Service
Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service).
'
additionalProperties:
type: string
example:
'1': 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice
'2': 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice
'3': 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice
readOnly: true
private_link_service_resource_ids:
type: object
description: 'The mapping of zones to Private Link Service Resource
IDs if available. Keys are zones
and values are [Azure Private Link Service Resource
IDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service).
'
additionalProperties:
type: string
example:
'1': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-1
'2': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-2
'3': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-3
readOnly: true
title: networking.v1.AzureNetwork
readOnly: true
idle_since:
type: string
format: date-time
example: '2024-01-01 00:00:00+00:00'
description: The date and time when the network becomes idle
readOnly: true
readOnly: true
title: networking.v1.NetworkStatus
title: networking.v1.Network
- type: object
required:
- api_version
- kind
- id
- spec
- status
properties:
spec:
type: object
required:
- cloud
- region
- connection_types
- environment
- type: object
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
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
'402':
x-summary: Over Quota
description: The request would exceed one or more quotas.
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: '402'
code: quota_exceeded
title: Kafka Clusters Per Org Quota Exceeded
detail: 'The request would exceed the quota: kafka_clusters_per_environment'
'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
'409':
x-summary: Conflict
description: The request is in conflict with the current server state
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
Location:
schema:
type: string
format: uri
example: https://api.confluent.cloud/{object}/{id}
description: Resource URI of conflicting resource
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: '409'
code: resource_already_exists
title: Resource Already exists
detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists.
'422':
description: Validation Failed
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:
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
- status: '422'
code: invalid_configuration
id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
title: Validation Failed
detail: 'The property ''/cluster/storage_size'' of type string did not match the following
type: integer'
source:
pointer: /cluster/storage_size
'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
jsonRequestBodyExample:
spec:
display_name: prod-aws-us-east1
cloud: AWS
region: us-east-1
connection_types:
- PRIVATELINK
cidr: 10.200.0.0/16
zones:
- use1-az1
- use1-az2
- use1-az3
zones_info:
- zone_id: use1-az3
cidr: 10.20.0.0/27
dns_config:
resolution: CHASED_PRIVATE
reserved_cidr: 172.20.255.0/24
environment:
id: env-00000