Skip to main content

List of Private Link Accesses

GET 

/networking/v1/private-link-accesses

General Availability

Retrieve a sorted, filtered, paginated list of all private link accesses.

Request

Responses

Private Link Access.

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.

OpenAPI definition (YAML)
paths:
  /networking/v1/private-link-accesses:
    get:
      x-lifecycle-stage: General Availability
      x-self-access: true
      operationId: listNetworkingV1PrivateLinkAccesses
      description: '[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)


        Retrieve a sorted, filtered, paginated list of all private link accesses.'
      parameters:
      - name: spec.display_name
        in: query
        required: false
        schema:
          description: Filter a collection by a string search for one or more values
          type: array
          items:
            type: string
          title: MultipleSearchFilter
        example:
        - prod-pl-use1
        - prod-pl-usw2
        description: Filter the results by exact match for spec.display_name. Pass multiple times to see
          results matching any of the values.
        style: form
        explode: true
      - name: status.phase
        in: query
        required: false
        schema:
          description: Filter a collection by a string search for one or more values
          type: array
          items:
            type: string
          title: MultipleSearchFilter
        example:
        - PROVISIONING
        - READY
        description: Filter the results by exact match for status.phase. Pass multiple times to see results
          matching any of the values.
        style: form
        explode: true
      - name: environment
        in: query
        required: true
        schema:
          description: Filter a collection by a string search
          type: string
          title: SearchFilter
        example: env-00000
        description: Filter the results by exact match for environment.
      - name: spec.network
        in: query
        required: false
        schema:
          description: Filter a collection by a string search for one or more values
          type: array
          items:
            type: string
          title: MultipleSearchFilter
        example:
        - n-00000
        - n-00001
        description: Filter the results by exact match for spec.network. Pass multiple times to see results
          matching any of the values.
        style: form
        explode: true
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          default: 10
          maximum: 1000
          x-max-page-items: 1000
        description: A pagination size for collection requests.
      - name: page_token
        in: query
        required: false
        schema:
          type: string
          maxLength: 255
        description: An opaque pagination token for collection requests.
      tags:
      - Private Link Accesses (networking/v1)
      security:
      - cloud-api-key: []
      - confluent-sts-access-token: []
      responses:
        '200':
          description: Private Link Access.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  description: 'Add or remove access to PrivateLink endpoints by AWS account, Azure subscription
                    and GCP project ID.


                    Related guides:

                    * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html).

                    * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html).

                    * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).



                    ## The Private Link Accesses Model

                    <SchemaDefinition schemaRef="#/components/schemas/networking.v1.PrivateLinkAccess"
                    />


                    ## Quotas and Limits

                    This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):


                    | Quota | Description |

                    | --- | --- |

                    | `private_link_accounts_per_network` | Number of AWS accounts per network |

                    | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network
                    |

                    | `private_service_connect_projects_per_network` | Number of GCP projects 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:
                      - PrivateLinkAccessList
                    metadata:
                      allOf:
                      - type: object
                        description: ListMeta describes metadata that resource collections may have
                        properties:
                          first:
                            description: A link to the first page of results. If a response does not contain
                              a first link, then direct navigation to the first page is not supported.
                            type: string
                            format: uri
                            nullable: true
                            example: https://api.confluent.cloud/v2/resourcekinds
                          last:
                            description: A link to the last page of results. If a response does not contain
                              a last link, then direct navigation to the last page is not supported.
                            type: string
                            format: uri
                            nullable: true
                            example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT
                          prev:
                            description: A link to the previous page of results. If a response does not
                              contain a prev link, then either there is no previous data or backwards
                              traversal through the result set is not supported.
                            type: string
                            format: uri
                            nullable: true
                            example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld
                          next:
                            description: A link to the next page of results. If a response does not contain
                              a next link, then there is no more data available.
                            type: string
                            format: uri
                            nullable: true
                            example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb
                          total_size:
                            description: Number of records in the full result set. This response may be
                              paginated and have a smaller number of records.
                            type: integer
                            format: int32
                            minimum: 0
                            example: 123
                        title: ListMeta
                      - properties:
                          first:
                            example: https://api.confluent.cloud/networking/v1/private-link-accesses
                          last:
                            example: https://api.confluent.cloud/networking/v1/private-link-accesses?page_token=bcAOehAY8F16YD84Z1wT
                          prev:
                            example: https://api.confluent.cloud/networking/v1/private-link-accesses?page_token=YIXRY97wWYmwzrax4dld
                          next:
                            example: https://api.confluent.cloud/networking/v1/private-link-accesses?page_token=UvmDWOB1iwfAIBPj6EYb
                    data:
                      type: array
                      description: A data property that contains an array of resource items. Each entry
                        in the array is a separate resource.
                      items:
                        allOf:
                        - type: object
                          description: 'Add or remove access to PrivateLink endpoints by AWS account,
                            Azure subscription and GCP project ID.


                            Related guides:

                            * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html).

                            * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html).

                            * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).



                            ## The Private Link Accesses Model

                            <SchemaDefinition schemaRef="#/components/schemas/networking.v1.PrivateLinkAccess"
                            />


                            ## Quotas and Limits

                            This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):


                            | Quota | Description |

                            | --- | --- |

                            | `private_link_accounts_per_network` | Number of AWS accounts per network
                            |

                            | `private_link_subscriptions_per_network` | Number of Azure subscriptions
                            per network |

                            | `private_service_connect_projects_per_network` | Number of GCP projects
                            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:
                              - PrivateLinkAccess
                            id:
                              description: ID is the "natural identifier" for an object within its scope/namespace;
                                it is normally unique across time but not space. That is, you can assume
                                that the ID will not be reclaimed and reused after an object is deleted
                                ("time"); however, it may collide with IDs for other object `kinds` or
                                objects of the same `kind` within a different scope/namespace ("space").
                              type: string
                              maxLength: 255
                              readOnly: true
                              example: dlz-f3a90de
                            metadata:
                              allOf:
                              - description: ObjectMeta is metadata that all persisted resources must
                                  have, which includes all objects users must create.
                                required:
                                - self
                                properties:
                                  self:
                                    description: Self is a Uniform Resource Locator (URL) at which an
                                      object can be addressed. This URL encodes the service location,
                                      API version, and other particulars necessary to locate the resource
                                      at a point in time
                                    type: string
                                    format: uri
                                    readOnly: true
                                    example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de
                                  resource_name:
                                    description: Resource Name is a Uniform Resource Identifier (URI)
                                      that is globally unique across space and time. It is represented
                                      as a Confluent Resource Name
                                    type: string
                                    format: uri
                                    readOnly: true
                                    example: crn://confluent.cloud/kafka=lkc-f3a90de
                                  created_at:
                                    type: string
                                    format: date-time
                                    example: '2006-01-02T15:04:05-07:00'
                                    readOnly: true
                                    description: The date and time at which this object was created. It
                                      is represented in RFC3339 format and is in UTC.
                                  updated_at:
                                    type: string
                                    format: date-time
                                    example: '2006-01-02T15:04:05-07:00'
                                    readOnly: true
                                    description: The date and time at which this object was last updated.
                                      It is represented in RFC3339 format and is in UTC.
                                  deleted_at:
                                    type: string
                                    format: date-time
                                    example: '2006-01-02T15:04:05-07:00'
                                    readOnly: true
                                    description: The date and time at which this object was (or will be)
                                      deleted. It is represented in RFC3339 format and is in UTC.
                                readOnly: true
                                title: ObjectMeta
                              - properties:
                                  self:
                                    example: https://api.confluent.cloud/networking/v1/private-link-accesses/pla-12345
                                  resource_name:
                                    example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/private-link-access=pla-12345
                            spec:
                              type: object
                              description: The desired state of the Private Link Access
                              properties:
                                display_name:
                                  type: string
                                  description: The name of the PrivateLink access
                                  example: prod-pl-use1
                                cloud:
                                  type: object
                                  oneOf:
                                  - type: object
                                    title: AWS
                                    description: AWS PrivateLink access configuration.
                                    required:
                                    - kind
                                    - account
                                    properties:
                                      kind:
                                        description: PrivateLink kind type.
                                        type: string
                                        enum:
                                        - AwsPrivateLinkAccess
                                      account:
                                        type: string
                                        pattern: ^\d{12}$
                                        example: '000000000000'
                                        description: 'The AWS account ID for the account containing the
                                          VPCs you want to connect from using AWS PrivateLink.

                                          You can find your AWS account ID [here](https://console.aws.amazon.com/billing/home?#/account)

                                          under **My Account** in your AWS Management Console. Must be
                                          a **12 character string**.

                                          '
                                  - type: object
                                    title: AZURE
                                    description: Azure PrivateLink access configuration.
                                    required:
                                    - kind
                                    - subscription
                                    properties:
                                      kind:
                                        description: PrivateLink kind type.
                                        type: string
                                        enum:
                                        - AzurePrivateLinkAccess
                                      subscription:
                                        type: string
                                        minLength: 1
                                        description: 'The Azure subscription ID for the account containing
                                          the VNets you want to connect from using

                                          Azure Private Link. You can find your Azure subscription ID
                                          in the subscription section of your

                                          [Microsoft Azure Portal](https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade).

                                          Must be a valid **32 character UUID string**.

                                          '
                                  - type: object
                                    title: GCP
                                    description: GCP Private Service Connect access configuration.
                                    required:
                                    - kind
                                    - project
                                    properties:
                                      kind:
                                        description: PrivateLink kind type.
                                        type: string
                                        enum:
                                        - GcpPrivateServiceConnectAccess
                                      project:
                                        type: string
                                        minLength: 1
                                        description: 'The GCP project ID for the account containing the
                                          VPCs that you want to connect from

                                          using Private Service Connect. You can find your Google Cloud
                                          Project ID under **Project ID** section of

                                          your [Google Cloud Console dashboard](https://console.cloud.google.com/home/dashboard).

                                          '
                                  discriminator:
                                    propertyName: kind
                                    mapping:
                                      AwsPrivateLinkAccess:
                                        type: object
                                        title: AWS
                                        description: AWS PrivateLink access configuration.
                                        required:
                                        - kind
                                        - account
                                        properties:
                                          kind:
                                            description: PrivateLink kind type.
                                            type: string
                                            enum:
                                            - AwsPrivateLinkAccess
                                          account:
                                            type: string
                                            pattern: ^\d{12}$
                                            example: '000000000000'
                                            description: 'The AWS account ID for the account containing
                                              the VPCs you want to connect from using AWS PrivateLink.

                                              You can find your AWS account ID [here](https://console.aws.amazon.com/billing/home?#/account)

                                              under **My Account** in your AWS Management Console. Must
                                              be a **12 character string**.

                                              '
                                      AzurePrivateLinkAccess:
                                        type: object
                                        title: AZURE
                                        description: Azure PrivateLink access configuration.
                                        required:
                                        - kind
                                        - subscription
                                        properties:
                                          kind:
                                            description: PrivateLink kind type.
                                            type: string
                                            enum:
                                            - AzurePrivateLinkAccess
                                          subscription:
                                            type: string
                                            minLength: 1
                                            description: 'The Azure subscription ID for the account containing
                                              the VNets you want to connect from using

                                              Azure Private Link. You can find your Azure subscription
                                              ID in the subscription section of your

                                              [Microsoft Azure Portal](https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade).

                                              Must be a valid **32 character UUID string**.

                                              '
                                      GcpPrivateServiceConnectAccess:
                                        type: object
                                        title: GCP
                                        description: GCP Private Service Connect access configuration.
                                        required:
                                        - kind
                                        - project
                                        properties:
                                          kind:
                                            description: PrivateLink kind type.
                                            type: string
                                            enum:
                                            - GcpPrivateServiceConnectAccess
                                          project:
                                            type: string
                                            minLength: 1
                                            description: 'The GCP project ID for the account containing
                                              the VPCs that you want to connect from

                                              using Private Service Connect. You can find your Google
                                              Cloud Project ID under **Project ID** section of

                                              your [Google Cloud Console dashboard](https://console.cloud.google.com/home/dashboard).

                                              '
                                  description: The cloud-specific PrivateLink details.
                                  x-immutable: true
                                environment:
                                  allOf:
                                  - type: object
                                    description: ObjectReference provides information for you to locate
                                      the referred object
                                    required:
                                    - id
                                    - related
                                    - resource_name
                                    properties:
                                      id:
                                        type: string
                                        description: ID of the referred resource
                                        minLength: 1
                                        maxLength: 255
                                      environment:
                                        type: string
                                        description: Environment of the referred resource, if env-scoped
                                        minLength: 1
                                        maxLength: 255
                                      related:
                                        type: string
                                        format: uri
                                        description: API URL for accessing or modifying the referred object
                                        minLength: 1
                                        readOnly: true
                                      resource_name:
                                        type: string
                                        format: uri
                                        description: CRN reference to the referred resource
                                        minLength: 1
                                        readOnly: true
                                      api_version:
                                        type: string
                                        description: API group and version of the referred resource
                                        minLength: 1
                                        readOnly: true
                                      kind:
                                        type: string
                                        description: Kind of the referred resource
                                        minLength: 1
                                        readOnly: true
                                    title: ObjectReference
                                  description: The environment to which this belongs.
                                network:
                                  allOf:
                                  - type: object
                                    description: ObjectReference provides information for you to locate
                                      the referred object
                                    required:
                                    - id
                                    - related
                                    - resource_name
                                    properties:
                                      id:
                                        type: string
                                        description: ID of the referred resource
                                        minLength: 1
                                        maxLength: 255
                                      environment:
                                        type: string
                                        description: Environment of the referred resource, if env-scoped
                                        minLength: 1
                                        maxLength: 255
                                      related:
                                        type: string
                                        format: uri
                                        description: API URL for accessing or modifying the referred object
                                        minLength: 1
                                        readOnly: true
                                      resource_name:
                                        type: string
                                        format: uri
                                        description: CRN reference to the referred resource
                                        minLength: 1
                                        readOnly: true
                                      api_version:
                                        type: string
                                        description: API group and version of the referred resource
                                        minLength: 1
                                        readOnly: true
                                      kind:
                                        type: string
                                        description: Kind of the referred resource
                                        minLength: 1
                                        readOnly: true
                                    title: ObjectReference
                                  description: The network to which this belongs.
                                  x-immutable: true
                              x-enable-id: true
                              x-enable-listmeta: true
                              x-enable-objectmeta: true
                              title: networking.v1.PrivateLinkAccessSpec
                            status:
                              type: object
                              required:
                              - phase
                              description: The status of the Private Link Access
                              properties:
                                phase:
                                  type: string
                                  description: "The lifecycle phase of the PrivateLink access configuration:\n\
                                    \n  PROVISIONING: PrivateLink access provisioning is in progress;\n\
                                    \n  READY:  PrivateLink access is ready;\n\n  FAILED: PrivateLink\
                                    \ access is in a failed state;\n\n  DEPROVISIONING: PrivateLink access\
                                    \ deprovisioning is in progress;\n"
                                  readOnly: true
                                  example: READY
                                  enum:
                                  - PROVISIONING
                                  - READY
                                  - FAILED
                                  - DEPROVISIONING
                                error_code:
                                  type: string
                                  description: Error code if PrivateLink access is in a failed state.
                                    May be used for programmatic error checking.
                                  readOnly: true
                                error_message:
                                  type: string
                                  description: Displayable error message if PrivateLink access is in a
                                    failed state
                                  readOnly: true
                              readOnly: true
                              title: networking.v1.PrivateLinkAccessStatus
                          title: networking.v1.PrivateLinkAccess
                        - type: object
                          required:
                          - id
                          - metadata
                          - spec
                          - status
                          properties:
                            spec:
                              type: object
                              required:
                              - cloud
                              - environment
                              - network
                      uniqueItems: true
                  title: networking.v1.PrivateLinkAccessList
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        properties:
                          spec:
                            type: object
                            properties:
                              environment:
                                example:
                                  id: env-00000
                                  related: https://api.confluent.cloud/v2/environments/env-00000
                                  resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000
                              network:
                                example:
                                  id: n-00000
                                  related: https://api.confluent.cloud/networking/v1/networks/n-00000
                                  resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000
          headers:
            X-Request-Id:
              schema:
                type: string
              description: The unique identifier for the API request.
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The maximum number of requests you're permitted to make per time period.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: "The relative time in seconds until the current rate-limit window resets. \
                \ \n  \n**Important:** This differs from Github and Twitter's same-named header which\
                \ uses UTC epoch seconds. We use relative time to avoid client/server time synchronization\
                \ issues."
        '400':
          description: Bad Request
          headers:
            X-Request-Id:
              schema:
                type: string
              description: The unique identifier for the API request.
          content:
            application/json:
              schema:
                type: object
                description: Provides information about problems encountered while performing an operation.
                required:
                - errors
                properties:
                  errors:
                    description: List of errors which caused this operation to fail
                    type: array
                    items:
                      type: object
                      description: Describes a particular error encountered while performing an operation.
                      properties:
                        id:
                          description: A unique identifier for this particular occurrence of the problem.
                          type: string
                          maxLength: 255
                        status:
                          description: The HTTP status code applicable to this problem, expressed as a
                            string value.
                          type: string
                        code:
                          description: An application-specific error code, expressed as a string value.
                          type: string
                        title:
                          description: A short, human-readable summary of the problem. It **SHOULD NOT**
                            change from occurrence to occurrence of the problem, except for purposes of
                            localization.
                          type: string
                        detail:
                          description: A human-readable explanation specific to this occurrence of the
                            problem.
                          type: string
                        source:
                          type: object
                          description: If this error was caused by a particular part of the API request,
                            the source will point to the query string parameter or request body property
                            that caused it.
                          properties:
                            pointer:
                              description: A JSON Pointer [RFC6901] to the associated entity in the request
                                document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
                                field].
                              type: string
                            parameter:
                              description: A string indicating which query parameter caused the error.
                              type: string
                        error_code:
                          type: integer
                          format: int32
                        message:
                          type: string
                          nullable: true
                      additionalProperties: false
                      title: Error
                    uniqueItems: true
                title: Failure
              example:
                errors:
                - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
                  status: '400'
                  code: invalid_filter
                  title: Invalid Filter
                  detail: The 'delorean' resource can't be filtered by 'num_doors'
                  source:
                    parameter: num_doors
        '401':
          x-summary: Unauthorized
          description: The request lacks valid authentication credentials for this resource.
          headers:
            X-Request-Id:
              schema:
                type: string
              description: The unique identifier for the API request.
            WWW-Authenticate:
              schema:
                type: string
              description: The unique identifier for the API request.
              example: Basic error="invalid_key", error_description="The API Key is invalid"
          content:
            application/json:
              schema:
                type: object
                description: Provides information about problems encountered while performing an operation.
                required:
                - errors
                properties:
                  errors:
                    description: List of errors which caused this operation to fail
                    type: array
                    items:
                      type: object
                      description: Describes a particular error encountered while performing an operation.
                      properties:
                        id:
                          description: A unique identifier for this particular occurrence of the problem.
                          type: string
                          maxLength: 255
                        status:
                          description: The HTTP status code applicable to this problem, expressed as a
                            string value.
                          type: string
                        code:
                          description: An application-specific error code, expressed as a string value.
                          type: string
                        title:
                          description: A short, human-readable summary of the problem. It **SHOULD NOT**
                            change from occurrence to occurrence of the problem, except for purposes of
                            localization.
                          type: string
                        detail:
                          description: A human-readable explanation specific to this occurrence of the
                            problem.
                          type: string
                        source:
                          type: object
                          description: If this error was caused by a particular part of the API request,
                            the source will point to the query string parameter or request body property
                            that caused it.
                          properties:
                            pointer:
                              description: A JSON Pointer [RFC6901] to the associated entity in the request
                                document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
                                field].
                              type: string
                            parameter:
                              description: A string indicating which query parameter caused the error.
                              type: string
                        error_code:
                          type: integer
                          format: int32
                        message:
                          type: string
                          nullable: true
                      additionalProperties: false
                      title: Error
                    uniqueItems: true
                title: Failure
              example:
                errors:
                - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
                  status: '401'
                  code: user_unauthenticated
                  title: Authentication Required
                  detail: Valid authentication credentials must be provided
        '403':
          x-summary: Forbidden
          description: The access credentials were considered insufficient to grant access
          headers:
            X-Request-Id:
              schema:
                type: string
              description: The unique identifier for the API request.
          content:
            application/json:
              schema:
                type: object
                description: Provides information about problems encountered while performing an operation.
                required:
                - errors
                properties:
                  errors:
                    description: List of errors which caused this operation to fail
                    type: array
                    items:
                      type: object
                      description: Describes a particular error encountered while performing an operation.
                      properties:
                        id:
                          description: A unique identifier for this particular occurrence of the problem.
                          type: string
                          maxLength: 255
                        status:
                          description: The HTTP status code applicable to this problem, expressed as a
                            string value.
                          type: string
                        code:
                          description: An application-specific error code, expressed as a string value.
                          type: string
                        title:
                          description: A short, human-readable summary of the problem. It **SHOULD NOT**
                            change from occurrence to occurrence of the problem, except for purposes of
                            localization.
                          type: string
                        detail:
                          description: A human-readable explanation specific to this occurrence of the
                            problem.
                          type: string
                        source:
                          type: object
                          description: If this error was caused by a particular part of the API request,
                            the source will point to the query string parameter or request body property
                            that caused it.
                          properties:
                            pointer:
                              description: A JSON Pointer [RFC6901] to the associated entity in the request
                                document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
                                field].
                              type: string
                            parameter:
                              description: A string indicating which query parameter caused the error.
                              type: string
                        error_code:
                          type: integer
                          format: int32
                        message:
                          type: string
                          nullable: true
                      additionalProperties: false
                      title: Error
                    uniqueItems: true
                title: Failure
              example:
                errors:
                - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
                  status: '403'
                  code: user_unauthorized
                  title: User Access Unauthorized
                  detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the
                    'plutonium' role.
        '429':
          description: Rate Limit Exceeded
          headers:
            X-Request-Id:
              schema:
                type: string
              description: The unique identifier for the API request.
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The maximum number of requests you're permitted to make per time period.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: "The relative time in seconds until the current rate-limit window resets. \
                \ \n  \n**Important:** This differs from Github and Twitter's same-named header which\
                \ uses UTC epoch seconds. We use relative time to avoid client/server time synchronization\
                \ issues."
            Retry-After:
              schema:
                type: integer
              description: The number of seconds to wait until the rate limit window resets. Only sent
                when the rate limit is reached.
        '500':
          description: Oops, something went wrong!
          headers:
            X-Request-Id:
              schema:
                type: string
              description: The unique identifier for the API request.
          content:
            application/json:
              schema:
                type: object
                description: Provides information about problems encountered while performing an operation.
                required:
                - errors
                properties:
                  errors:
                    description: List of errors which caused this operation to fail
                    type: array
                    items:
                      type: object
                      description: Describes a particular error encountered while performing an operation.
                      properties:
                        id:
                          description: A unique identifier for this particular occurrence of the problem.
                          type: string
                          maxLength: 255
                        status:
                          description: The HTTP status code applicable to this problem, expressed as a
                            string value.
                          type: string
                        code:
                          description: An application-specific error code, expressed as a string value.
                          type: string
                        title:
                          description: A short, human-readable summary of the problem. It **SHOULD NOT**
                            change from occurrence to occurrence of the problem, except for purposes of
                            localization.
                          type: string
                        detail:
                          description: A human-readable explanation specific to this occurrence of the
                            problem.
                          type: string
                        source:
                          type: object
                          description: If this error was caused by a particular part of the API request,
                            the source will point to the query string parameter or request body property
                            that caused it.
                          properties:
                            pointer:
                              description: A JSON Pointer [RFC6901] to the associated entity in the request
                                document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
                                field].
                              type: string
                            parameter:
                              description: A string indicating which query parameter caused the error.
                              type: string
                        error_code:
                          type: integer
                          format: int32
                        message:
                          type: string
                          nullable: true
                      additionalProperties: false
                      title: Error
                    uniqueItems: true
                title: Failure
              example:
                errors:
                - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
                  status: '500'
                  code: out_of_gas
                  title: DeLorean Out Of Gas
                  detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap
      servers:
      - url: https://api.confluent.cloud
        description: Confluent Cloud API