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

# Criar chave

> Cria uma nova API key.



## OpenAPI

````yaml /pt-BR/_specs/cloud-openapi.json post /v1/organizations/{organizationId}/keys
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}/keys:
    post:
      tags:
        - OpenAPI
      summary: Criar chave
      description: Cria uma nova API key.
      parameters:
        - description: ID da organização proprietária da chave.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiKeyPostRequest'
      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/ApiKeyPostResponse'
                  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 processará a solicitação devido a algo
            percebido como um erro do cliente.
components:
  schemas:
    ApiKeyPostRequest:
      properties:
        expireAt:
          description: >-
            Timestamp de expiração da chave. Se não estiver presente, for `null`
            ou estiver vazio, a chave nunca expira. ISO-8601.
          format: date-time
          nullable: true
          type: string
        hashData:
          $ref: '#/components/schemas/ApiKeyHashData'
        ipAccessList:
          description: >-
            Lista de endereços IP com permissão para acessar a API usando esta
            chave
          items:
            $ref: '#/components/schemas/IpAccessListEntry'
          type: array
        name:
          description: Nome da chave.
          type: string
        roles:
          description: Lista de roles atribuídas à chave. Contém pelo menos 1 elemento.
          items:
            enum:
              - admin
              - developer
              - query_endpoints
            type: string
          type: array
        state:
          description: >-
            Estado inicial da chave: 'enabled', 'disabled'. Se não for
            fornecido, a nova chave será 'enabled'.
          enum:
            - enabled
            - disabled
          type: string
    ApiKeyPostResponse:
      properties:
        key:
          $ref: '#/components/schemas/ApiKey'
        keyId:
          description: >-
            ID da chave gerada. Fornecido apenas se não houver 'hashData' na
            solicitação.
          type: string
        keySecret:
          description: >-
            Secret da chave gerada. Fornecido apenas se não houver 'hashData' na
            solicitação.
          type: string
    ApiKeyHashData:
      properties:
        keyIdHash:
          description: 'Hash do ID da chave. '
          type: string
        keyIdSuffix:
          description: >-
            Últimos 4 dígitos do ID da chave. Algoritmo: echo -n "yourpassword"
            | sha256sum | tr -d '-' | xxd -r -p | base64
          type: string
        keySecretHash:
          description: >-
            Hash do segredo da chave. Algoritmo: echo -n "yourpassword" |
            sha256sum | tr -d '-' | xxd -r -p | base64
          type: string
    IpAccessListEntry:
      properties:
        description:
          description: >-
            Descrição opcional do endereço IPv4 ou CIDR IPv4 a partir do qual
            permitir o acesso
          type: string
        source:
          description: IP ou CIDR
          type: string
    ApiKey:
      properties:
        createdAt:
          description: Timestamp de criação da chave. ISO-8601.
          format: date-time
          type: string
        expireAt:
          description: >-
            Timestamp de expiração da chave. Se não estiver presente, for `null`
            ou estiver vazio, a chave nunca expira. ISO-8601.
          format: date-time
          nullable: true
          type: string
        id:
          description: ID exclusivo da API key.
          format: uuid
          type: string
        ipAccessList:
          description: Lista de endereços IP autorizados a acessar a API usando esta chave
          items:
            $ref: '#/components/schemas/IpAccessListEntry'
          type: array
        keySuffix:
          description: Últimos 4 caracteres da chave.
          type: string
        name:
          description: Nome da chave
          type: string
        roles:
          description: Lista de funções atribuídas à chave. Contém pelo menos 1 elemento.
          items:
            enum:
              - admin
              - developer
              - query_endpoints
            type: string
          type: array
        state:
          description: 'Estado da chave: ''enabled'', ''disabled''.'
          enum:
            - enabled
            - disabled
          type: string
        usedAt:
          description: >-
            Timestamp da última vez em que a chave foi usada. Se não estiver
            presente, a chave nunca foi usada. ISO-8601.
          format: date-time
          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

````