> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-55d9d317.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter a configuração do Private Endpoint

> Informações necessárias para configurar um Private Endpoint



## OpenAPI

````yaml /pt-BR/_specs/cloud-openapi.json get /v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig
openapi: 3.0.1
info:
  contact:
    email: support@clickhouse.com
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-299828
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: User management
  - name: Billing
  - name: Service
  - name: Backup
  - name: OpenAPI
  - name: Prometheus
  - name: ClickPipes
paths:
  /v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig:
    get:
      tags:
        - Service
      summary: Obter a configuração do Private Endpoint
      description: Informações necessárias para configurar um Private Endpoint
      parameters:
        - description: ID da organização solicitada.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
        - description: ID do serviço solicitado.
          in: path
          name: serviceId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: ID exclusivo atribuído a cada solicitação. UUIDv4
                    format: uuid
                    type: string
                  result:
                    $ref: '#/components/schemas/PrivateEndpointConfig'
                  status:
                    description: Código de status HTTP.
                    example: 200
                    type: number
                type: object
          description: Resposta bem-sucedida
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: Descrição detalhada do erro.
                    type: string
                  status:
                    description: Código de status HTTP.
                    example: 400
                    type: number
                type: object
          description: >-
            O servidor não pode ou não quer processar a solicitação devido a
            algo que considera ser um erro do cliente.
components:
  schemas:
    PrivateEndpointConfig:
      properties:
        endpointServiceId:
          description: >-
            Identificador exclusivo do endpoint de interface que você criou na
            sua VPC com o recurso AWS(Service Name), GCP(Target Service) ou
            AZURE (Private Link Service)
          type: string
        privateDnsHostname:
          description: Hostname DNS privado da VPC que você criou
          type: string
  securitySchemes:
    basicAuth:
      description: >-
        Use o ID da chave e o segredo da chave obtidos no console do ClickHouse
        Cloud: https://clickhouse.com/docs/cloud/manage/openapi
      scheme: basic
      type: http

````