openapi: 3.2.0
info:
title: Confluent Cloud Network Link Endpoints (networking/v1) API
version: ''
x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b
x-audience: external-public
x-logo:
url: https://assets.confluent.io/m/1661ef5e4ff82d3d/
description: '# Introduction
Note
This documents the collection of Confluent Cloud APIs.'
servers:
- url: https://api.confluent.cloud
description: Confluent Cloud API
tags:
- name: Network Link Endpoints (networking/v1)
description: '
A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a
Network Link Service (associated with another Private Link Confluent Cloud Network) at the target.'
paths:
/networking/v1/network-link-endpoints:
x-lifecycle-stage: General Availability
x-self-access: true
get:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: listNetworkingV1NetworkLinkEndpoints
summary: List of Network Link Endpoints
description: '
Retrieve a sorted, filtered, paginated list of all network link endpoints.'
parameters:
- name: spec.display_name
in: query
required: false
schema:
$ref: '#/components/schemas/MultipleSearchFilter'
example:
- prod-net-1-nle
- dev-net-1-nle
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:
$ref: '#/components/schemas/MultipleSearchFilter'
example:
- READY
- PENDING_ACCEPT
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:
$ref: '#/components/schemas/SearchFilter'
example: env-00000
description: Filter the results by exact match for environment.
- name: spec.network
in: query
required: false
schema:
$ref: '#/components/schemas/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: spec.network_link_service
in: query
required: false
schema:
$ref: '#/components/schemas/MultipleSearchFilter'
example:
- nls-abcde
- nls-00000
description: Filter the results by exact match for spec.network_link_service. 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:
- Network Link Endpoints (networking/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
responses:
'200':
description: Network Link Endpoint.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointList'
- 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
network_link_service:
example:
id: nls-abcde
related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde
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':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthenticatedError'
'403':
$ref: '#/components/responses/UnauthorizedError'
'429':
$ref: '#/components/responses/RateLimitError'
'500':
$ref: '#/components/responses/DefaultSystemError'
post:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: createNetworkingV1NetworkLinkEndpoint
summary: Create a Network Link Endpoint
description: '
Make a request to create a network link endpoint.'
tags:
- Network Link Endpoints (networking/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint'
- type: object
required:
- spec
properties:
spec:
type: object
required:
- environment
- network
- network_link_service
- type: object
properties:
spec:
type: object
properties:
environment:
example:
id: env-00000
network:
example:
id: n-00000
network_link_service:
example:
id: nls-abcde
responses:
'202':
description: A Network Link Endpoint is being created.
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."
Location:
schema:
type: string
format: uri
example: https://api.confluent.cloud/networking/v1/network-link-endpoints/{id}
description: NetworkLinkEndpoint resource uri
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint'
- type: object
required:
- spec
- status
properties:
spec:
type: object
required:
- environment
- network
- network_link_service
- 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
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
network_link_service:
example:
id: nls-abcde
related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthenticatedError'
'402':
$ref: '#/components/responses/OverQuotaError'
'403':
$ref: '#/components/responses/UnauthorizedError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/ValidationError'
'429':
$ref: '#/components/responses/RateLimitError'
'500':
$ref: '#/components/responses/DefaultSystemError'
/networking/v1/network-link-endpoints/{id}:
x-lifecycle-stage: General Availability
x-self-access: true
get:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: getNetworkingV1NetworkLinkEndpoint
summary: Read a Network Link Endpoint
description: '
Make a request to read a network link endpoint.'
parameters:
- name: environment
in: query
required: true
schema:
$ref: '#/components/schemas/SearchFilter'
example: env-00000
description: Scope the operation to the given environment.
- name: id
in: path
required: true
schema:
type: string
description: The unique identifier for the network link endpoint.
tags:
- Network Link Endpoints (networking/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
responses:
'200':
description: Network Link Endpoint.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint'
- type: object
required:
- api_version
- kind
- id
- spec
- status
properties:
spec:
type: object
required:
- environment
- network
- network_link_service
- 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
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
network_link_service:
example:
id: nls-abcde
related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde
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':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthenticatedError'
'403':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'429':
$ref: '#/components/responses/RateLimitError'
'500':
$ref: '#/components/responses/DefaultSystemError'
patch:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: updateNetworkingV1NetworkLinkEndpoint
summary: Update a Network Link Endpoint
description: '
Make a request to update a network link endpoint.'
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The unique identifier for the network link endpoint.
tags:
- Network Link Endpoints (networking/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint'
- type: object
required:
- spec
properties:
spec:
type: object
required:
- environment
properties:
environment:
example:
id: env-00000
responses:
'200':
description: Network Link Endpoint.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint'
- type: object
required:
- api_version
- kind
- id
- spec
- status
properties:
spec:
type: object
required:
- environment
- network
- network_link_service
- 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
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
network_link_service:
example:
id: nls-abcde
related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde
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':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthenticatedError'
'402':
$ref: '#/components/responses/OverQuotaError'
'403':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/ValidationError'
'429':
$ref: '#/components/responses/RateLimitError'
'500':
$ref: '#/components/responses/DefaultSystemError'
delete:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: deleteNetworkingV1NetworkLinkEndpoint
summary: Delete a Network Link Endpoint
description: '
Make a request to delete a network link endpoint.'
parameters:
- name: environment
in: query
required: true
schema:
$ref: '#/components/schemas/SearchFilter'
example: env-00000
description: Scope the operation to the given environment.
- name: id
in: path
required: true
schema:
type: string
description: The unique identifier for the network link endpoint.
tags:
- Network Link Endpoints (networking/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
responses:
'204':
description: A Network Link Endpoint is being deleted.
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':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthenticatedError'
'403':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'429':
$ref: '#/components/responses/RateLimitError'
'500':
$ref: '#/components/responses/DefaultSystemError'
components:
schemas:
Error:
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
- 'null'
additionalProperties: false
GlobalObjectReference:
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
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
networking.v1.NetworkLinkEndpointList:
type: object
description: 'A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a
Network Link Service (associated with another Private Link Confluent Cloud Network) at the target.
It enables connectivity between the origin network and the target network.
It can only be associated with a Private Link network.
Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).
## The Network Link Endpoints Model
## Quotas and Limits
This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):
| Quota | Description |
| --- | --- |
| `network_link_endpoints_per_network` | Number of network link endpoints 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:
- NetworkLinkEndpointList
metadata:
allOf:
- $ref: '#/components/schemas/ListMeta'
- properties:
first:
example: https://api.confluent.cloud/networking/v1/network-link-endpoints
last:
example: https://api.confluent.cloud/networking/v1/network-link-endpoints?page_token=bcAOehAY8F16YD84Z1wT
prev:
example: https://api.confluent.cloud/networking/v1/network-link-endpoints?page_token=YIXRY97wWYmwzrax4dld
next:
example: https://api.confluent.cloud/networking/v1/network-link-endpoints?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:
- $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint'
- type: object
required:
- id
- metadata
- spec
- status
properties:
spec:
type: object
required:
- environment
- network
- network_link_service
uniqueItems: true
networking.v1.NetworkLinkEndpoint:
type: object
description: 'A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a
Network Link Service (associated with another Private Link Confluent Cloud Network) at the target.
It enables connectivity between the origin network and the target network.
It can only be associated with a Private Link network.
Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html).
## The Network Link Endpoints Model
## Quotas and Limits
This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):
| Quota | Description |
| --- | --- |
| `network_link_endpoints_per_network` | Number of network link endpoints 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:
- NetworkLinkEndpoint
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:
- $ref: '#/components/schemas/ObjectMeta'
- properties:
self:
example: https://api.confluent.cloud/networking/v1/network-link-endpoints/nle-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-endpoint=nle-12345
spec:
$ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec'
status:
$ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus'
SearchFilter:
description: Filter a collection by a string search
type: string
ListMeta:
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
- 'null'
format: uri
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
- 'null'
format: uri
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
- 'null'
format: uri
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
- 'null'
format: uri
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
EnvScopedObjectReference:
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
MultipleSearchFilter:
description: Filter a collection by a string search for one or more values
type: array
items:
type: string
networking.v1.NetworkLinkEndpointStatus:
type: object
required:
- phase
description: The status of the Network Link Endpoint
properties:
phase:
type: string
x-extensible-enum:
- PROVISIONING
- PENDING_ACCEPT
- READY
- FAILED
- DEPROVISIONING
- EXPIRED
- DISCONNECTED
- DISCONNECTING
- INACTIVE
description: "The lifecycle phase of the network link endpoint:\n\n PROVISIONING: network link endpoint provisioning is in progress;\n\n PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target;\n\n READY: network link endpoint is ready;\n\n FAILED: network link endpoint is in a failed state;\n\n DEPROVISIONING: network link endpoint deprovisioning is in progress;\n\n EXPIRED: network link endpoint request is expired, can only be deleted;\n\n DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions;\n\n DISCONNECTING: network link endpoint disconnection is in progress;\n\n INACTIVE: network link endpoint is created, but not active since there are no clusters in the network;\n"
readOnly: true
example: READY
error_code:
type: string
description: Error code if network link is in a failed state. May be used for programmatic error checking.
readOnly: true
error_message:
type: string
description: Displayable error message if network link is in a failed state
readOnly: true
expires_at:
type: string
format: date-time
example: 2024-01-01 00:00:00+00:00
description: The date and time when the request expires if it is not accepted by the target network admin.
readOnly: true
readOnly: true
ObjectMeta:
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
Failure:
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:
$ref: '#/components/schemas/Error'
uniqueItems: true
networking.v1.NetworkLinkEndpointSpec:
type: object
description: The desired state of the Network Link Endpoint
properties:
display_name:
type: string
description: The name of the network link endpoint
example: prod-net-1-nle
description:
type: string
description: The description of the network link endpoint
example: Connect to Network - analytics hub
environment:
allOf:
- $ref: '#/components/schemas/GlobalObjectReference'
description: The environment to which this belongs.
network:
allOf:
- $ref: '#/components/schemas/EnvScopedObjectReference'
description: The network to which this belongs.
x-immutable: true
network_link_service:
allOf:
- $ref: '#/components/schemas/EnvScopedObjectReference'
description: The network_link_service to which this belongs.
x-immutable: true
x-enable-id: true
x-enable-listmeta: true
x-enable-objectmeta: true
responses:
OverQuotaError:
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:
$ref: '#/components/schemas/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'
UnauthenticatedError:
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:
$ref: '#/components/schemas/Failure'
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '401'
code: user_unauthenticated
title: Authentication Required
detail: Valid authentication credentials must be provided
UnauthorizedError:
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:
$ref: '#/components/schemas/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.
NotFoundError:
description: Not Found
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
$ref: '#/components/schemas/Failure'
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '404'
title: Not Found
ConflictError:
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:
$ref: '#/components/schemas/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.
DefaultSystemError:
description: Oops, something went wrong!
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
$ref: '#/components/schemas/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
ValidationError:
description: Validation Failed
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
$ref: '#/components/schemas/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
- 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
BadRequestError:
description: Bad Request
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
$ref: '#/components/schemas/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
RateLimitError:
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.
securitySchemes:
cloud-api-key:
type: http
scheme: basic
description: Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.
confluent-sts-access-token:
type: oauth2
description: Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
flows:
clientCredentials:
tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token
scopes: {}
global-api-key:
type: http
scheme: basic
description: Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
resource-api-key:
type: http
scheme: basic
description: Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret as the password.
external-access-token:
type: oauth2
description: Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
flows:
clientCredentials:
tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token
scopes: {}
oauth:
type: oauth2
description: Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.
flows:
clientCredentials:
tokenUrl: /oauth2/token
scopes:
partner:alter: enables partners to alter entitlements
partner:create: enables partners to create entitlements and signup on behalf of customers
partner:delete: enables partners to delete entitlements and organizations
partner:describe: enables partners to read and list entitlements and organizations
x-tagGroups:
- name: Identity Access Management (v2)
tags:
- API Keys (iam/v2)
- Users (iam/v2)
- Service Accounts (iam/v2)
- Invitations (iam/v2)
- IP Groups (iam/v2)
- IP Filters (iam/v2)
- IP Filter Summaries (iam/v2)
- Role Bindings (iam/v2)
- Identity Providers (iam/v2)
- Jwks (iam/v2)
- Identity Pools (iam/v2)
- Group Mappings (iam/v2/sso)
- Certificate Authorities (iam/v2)
- Certificate Identity Pools (iam/v2)
- name: Org API (v2)
tags:
- Environments (org/v2)
- Organizations (org/v2)
- name: Notifications API (v1)
tags:
- Subscriptions (notifications/v1)
- Integrations (notifications/v1)
- Notification Types (notifications/v1)
- Resource Preferences (notifications/v1)
- Resource Subscriptions (notifications/v1)
- User Notifications (notifications/v1)
- name: Cluster Mgmt for Kafka (v2)
tags:
- Clusters (cmk/v2)
- name: Cluster Mgmt for ksqlDB (v2)
tags:
- Clusters (ksqldbcm/v2)
- name: Connect API (v1)
tags:
- Connectors (connect/v1)
- Lifecycle (connect/v1)
- Status (connect/v1)
- Managed Connector Plugins (connect/v1)
- Offsets (connect/v1)
- Custom Connector Plugins (connect/v1)
- Presigned Urls (connect/v1)
- Custom Connector Runtimes (connect/v1)
- name: Connect Artifact Management (v1)
tags:
- Connect Artifacts (cam/v1)
- Presigned Urls (cam/v1)
- name: Kafka API (v3)
tags:
- Cluster (v3)
- Configs (v3)
- ACL (v3)
- Consumer Group (v3)
- Partition (v3)
- Topic (v3)
- Records (v3)
- Cluster Linking (v3)
- Share Group (v3)
- Streams Group (v3)
- name: Service Quota API (v1)
tags:
- Applied Quotas (service-quota/v1)
- Scopes (service-quota/v1)
- name: Partner API (v2)
tags:
- Entitlements (partner/v2)
- Organizations (partner/v2)
- Signup (partner/v2)
- name: Cluster Mgmt for Schema Registry (v2)
tags:
- Regions (srcm/v2)
- Clusters (srcm/v2)
- name: Cluster Mgmt for Schema Registry (v3)
tags:
- Clusters (srcm/v3)
- name: Schema Registry API (v1)
tags:
- Compatibility (v1)
- Config (v1)
- Contexts (v1)
- Exporters (v1)
- Modes (v1)
- Schemas (v1)
- Subjects (v1)
- Key Encryption Keys (v1)
- Data Encryption Keys (v1)
- name: Catalog API (v1)
tags:
- Entity (v1)
- Search (v1)
- Types (v1)
- name: Stream Sharing API (v1)
tags:
- Provider Shared Resources (cdx/v1)
- Provider Shares (cdx/v1)
- Consumer Shared Resources (cdx/v1)
- Consumer Shares (cdx/v1)
- Shared Tokens (cdx/v1)
- Opt Ins (cdx/v1)
- name: Networking (v1)
tags:
- Networks (networking/v1)
- Peerings (networking/v1)
- Transit Gateway Attachments (networking/v1)
- Private Link Accesses (networking/v1)
- Network Link Services (networking/v1)
- Network Link Endpoints (networking/v1)
- Network Link Service Associations (networking/v1)
- IP Addresses (networking/v1)
- Private Link Attachments (networking/v1)
- Private Link Attachment Connections (networking/v1)
- DNS Forwarders (networking/v1)
- Access Points (networking/v1)
- DNS Records (networking/v1)
- Gateways (networking/v1)
- name: Security Token Service (v1)
tags:
- OAuth Tokens (sts/v1)
- name: Kafka Quota (v1)
tags:
- Client Quotas (kafka-quotas/v1)
- name: Bring Your Own Key (BYOK) Management (v1)
tags:
- Keys (byok/v1)
- name: Billing API (v1)
tags:
- Costs (billing/v1)
- name: Compute Pool Mgmt for Flink (v2)
tags:
- Compute Pools (fcpm/v2)
- Regions (fcpm/v2)
- Org Compute Pool Configs (fcpm/v2)
- name: SQL API (v1)
tags:
- Statements (sql/v1)
- Statement Results (sql/v1)
- Statement Exceptions (sql/v1)
- Connections (sql/v1)
- Agents (sql/v1)
- Tools (sql/v1)
- Materialized Tables (sql/v1)
- Materialized Table Versions (sql/v1)
- name: Provider Integration Management (v1)
tags:
- Integrations (pim/v1)
- name: Provider Integration Management (v2)
tags:
- Integrations (pim/v2)
- name: Artifact API (v1)
tags:
- Flink Artifacts (artifact/v1)
- Presigned Urls (artifact/v1)
- Flink Artifact Versions (artifact/v1)
- name: Custom Code Logging API (v1)
tags:
- Custom Code Loggings (ccl/v1)
- name: Tableflow (v1)
tags:
- Regions (tableflow/v1)
- Tableflow Topics (tableflow/v1)
- Catalog Integrations (tableflow/v1)
- name: Custom Connect Plugin Management (v1)
tags:
- Custom Connect Plugins (ccpm/v1)
- Presigned Urls (ccpm/v1)
- Custom Connect Plugin Versions (ccpm/v1)
- name: Unified Stream Manager (v1)
tags:
- Kafka Clusters (usm/v1)
- Connect Clusters (usm/v1)
- name: Endpoint (v1)
tags:
- Endpoints (endpoint/v1)
- name: Real Time Context Engine (v1)
tags:
- Rtce Topics (rtce/v1)
- Regions (rtce/v1)
- name: Analytics (v1alpha1)
tags:
- Statements (query/v1alpha1)