> ## Documentation Index
> Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar certificado

> Crie um novo certificado. Padrões para emissão ACME; definir `source=uploaded` para armazenar material PEM fornecido pelo cliente diretamente.

Para fonte ACME: retorna 202 com status pending_dns e uma entrada de `challenges` por domínio normalizado, incluindo `cname_record_name`, `expected_cname` e `our_dns`. Use esses campos diretamente da resposta de criação para configurar o DNS. O planejamento de desafios é concluído antes que a criação seja aceita; uma falha de planejamento rejeita a solicitação sem salvar um certificado ou um plano de desafios parcial.

Quando `our_dns=true`, o CNAME é criado automaticamente durante a emissão assíncrona. Caso contrário, publique `cname_record_name CNAME
expected_cname` no seu provedor de DNS. Os curingas são validados pelo nome principal; um apex e seu curinga compartilham o mesmo CNAME. Poll GET /v1/certificates/{certificate_id} para ver o progresso. O certificado torna-se ativo quando cada desafio é verificado e a emissão é concluída.

Para fonte enviada: retorna 201 com status ativo.


<Info>
  Requer a ação do IAM **`certificate:CreateCertificate`**. Consulte [permissões de certificados](/certificate/permissions) para obter a lista completa, o que cada uma cobre e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/certificate.yaml post /v1/certificates
openapi: 3.0.3
info:
  title: API de certificado de Basaltic
  version: 1.0.0
  description: >
    Certificados TLS para ouvintes de balanceamento de carga e endpoints de
    plataforma — emita, inspecione, recupere material e revogue. Os nomes são
    imutáveis e únicos dentro de uma conta. Lista por nome exato ou CRN;
    caminhos de recursos usam UUIDs.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://certificate.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/certificates:
    post:
      tags:
        - Certificates
      summary: Criar certificado
      description: >
        Crie um novo certificado. Padrões para emissão ACME; definir
        `source=uploaded` para armazenar material PEM fornecido pelo cliente
        diretamente.


        Para fonte ACME: retorna 202 com status pending_dns e uma entrada de
        `challenges` por domínio normalizado, incluindo `cname_record_name`,
        `expected_cname` e `our_dns`. Use esses campos diretamente da resposta
        de criação para configurar o DNS. O planejamento de desafios é concluído
        antes que a criação seja aceita; uma falha de planejamento rejeita a
        solicitação sem salvar um certificado ou um plano de desafios parcial.


        Quando `our_dns=true`, o CNAME é criado automaticamente durante a
        emissão assíncrona. Caso contrário, publique `cname_record_name CNAME

        expected_cname` no seu provedor de DNS. Os curingas são validados pelo
        nome principal; um apex e seu curinga compartilham o mesmo CNAME. Poll
        GET /v1/certificates/{certificate_id} para ver o progresso. O
        certificado torna-se ativo quando cada desafio é verificado e a emissão
        é concluída.


        Para fonte enviada: retorna 201 com status ativo.
      operationId: createCertificate
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CertificateIssueRequest'
      responses:
        '201':
          description: Certificado carregado armazenado (source=uploaded)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateResponse'
        '202':
          description: >-
            Emissão iniciada (source=acme). status é pending_dns e challenges
            contém o plano de delegação DNS completo, pronto para configurar.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: Nome do certificado já em uso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Chave opcional gerada pelo cliente que torna uma criação segura para
        reprodução. A reintentar uma solicitação com a mesma chave retorna o
        resultado original literalmente em vez de criar um recurso duplicado. A
        reutilização de uma chave com um corpo de solicitação diferente é
        rejeitada (422); uma solicitação cuja chave ainda está sendo processada
        retorna 409. Os registros são honrados por 24 horas. Use um UUID ou
        token exclusivo semelhante.
      required: false
      schema:
        type: string
        maxLength: 255
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    CertificateIssueRequest:
      type: object
      required:
        - name
        - domains
      properties:
        name:
          type: string
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{0,253}$
          description: >-
            Único por conta. Surfaces no CRN
            (`crn:certificate::<account>:certificate/<name>`), então ele deve
            ser seguro para URLs — letras, dígitos, ponto, traço, sublinhado. Os
            nomes de recursos não devem começar com o prefixo literal crn: ou
            ser UUIDs (formas canônicas, compactas, entre colchetes ou
            urn:uuid:, em qualquer caso).
          example: prod-frontend
        domains:
          type: array
          items:
            type: string
          minItems: 1
          maxItems: 100
          description: >
            Limitado a 100 para ficar dentro dos limites por pedido da
            autoridade de certificação.
          example:
            - example.com
            - www.example.com
            - api.example.com
        key_algorithm:
          $ref: '#/components/schemas/CertificateKeyAlgorithm'
        source:
          $ref: '#/components/schemas/CertificateSource'
          description: >
            Padrões para "acme" — emitido pela CA da plataforma. Defina para
            "uploaded" para armazenar material PEM fornecido pelo cliente;
            certificate_pem + private_key_pem deve ser fornecido.
        certificate_pem:
          type: string
          description: >-
            Certificado de folha codificado por PEM. Necessário quando
            source=uploaded.
          example: |
            -----BEGIN CERTIFICATE-----
            MIIDdzCCAl+gAwIBAgIEAaH...
            -----END CERTIFICATE-----
        chain_pem:
          type: string
          description: >-
            Cadeia intermediária codificada em PEM (opcional quando
            source=uploaded).
          example: |
            -----BEGIN CERTIFICATE-----
            MIIEFzCCAv+gAwIBAgIEBb2...
            -----END CERTIFICATE-----
        private_key_pem:
          type: string
          description: Chave privada codificada por PEM. Necessário quando source=uploaded.
          example: |
            -----BEGIN PRIVATE KEY-----
            MIGHAgEAMBMGByqGSM49AgEG...
            -----END PRIVATE KEY-----
        tags:
          $ref: '#/components/schemas/Tags'
    CertificateResponse:
      type: object
      properties:
        certificate:
          $ref: '#/components/schemas/Certificate'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    CertificateKeyAlgorithm:
      type: string
      enum:
        - ecdsa-p256
        - ecdsa-p384
        - rsa-2048
        - rsa-4096
      default: ecdsa-p256
    CertificateSource:
      type: string
      enum:
        - acme
        - uploaded
      example: acme
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    Certificate:
      type: object
      required:
        - faults
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        crn:
          type: string
          readOnly: true
          description: >-
            Baseado em nome, para que uma política do IAM possa usar um curinga
            em uma convenção de nomenclatura
            (`crn:certificate::my-account:certificate/prod-*`). O slot de região
            está vazio para compatibilidade; o armazenamento de certificados e o
            material do KMS são regionais.
          example: crn:certificate::my-account:certificate/prod-frontend
        name:
          description: >-
            Os nomes de recursos não devem começar com o prefixo literal crn: ou
            ser UUIDs (formas canônicas, compactas, entre colchetes ou
            urn:uuid:, em qualquer caso).
          type: string
          example: prod-frontend
        domains:
          type: array
          items:
            type: string
          example:
            - example.com
            - www.example.com
            - api.example.com
        status:
          $ref: '#/components/schemas/CertificateStatus'
        source:
          $ref: '#/components/schemas/CertificateSource'
        key_algorithm:
          $ref: '#/components/schemas/CertificateKeyAlgorithm'
        challenges:
          type: array
          items:
            $ref: '#/components/schemas/CertificateChallenge'
          description: >
            Estado de delegação CNAME por domínio — uma entrada por domínio no
            certificado. Enquanto status=pending_dns emissão espera por cada
            desafio`verified` para virar verdadeiro; use `expected_cname` e
            `our_dns` para dizer quais registros precisam ser adicionados no
            registrador.
        certificate_pem:
          type: string
          description: Certificado de folha codificado por PEM. Vazio até ativo.
          example: |
            -----BEGIN CERTIFICATE-----
            MIIDdzCCAl+gAwIBAgIEAaH...
            -----END CERTIFICATE-----
        chain_pem:
          type: string
          description: Cadeia intermediária codificada por PEM.
          example: |
            -----BEGIN CERTIFICATE-----
            MIIEFzCCAv+gAwIBAgIEBb2...
            -----END CERTIFICATE-----
        fingerprint:
          type: string
          readOnly: true
          description: >
            Hex SHA-256 do DER da folha — a versão material do certificado.
            Mudanças em cada rotação; os consumidores usam isso para saber
            quando buscar material novamente e para verificar se buscaram a
            geração pretendida. Esvazie até que o certificado tenha uma folha.
          example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
        issued_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:30:00Z'
        expires_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-04-15T09:30:00Z'
        faults:
          type: array
          items:
            $ref: '#/components/schemas/Fault'
          description: >
            Falhas ativas, ordenadas pela mais recente primeiro. Vazio quando
            saudável. As falhas de renovação são avisos enquanto o material de
            certificado válido ainda serve. Códigos:
            CERTIFICATE_ISSUANCE_START_FAILED (a emissão não pôde ser agendada),
            CERTIFICATE_ISSUANCE_FAILED (falha na solicitação de assinatura),
            CERTIFICATE_RENEWAL_FAILED (a renovação não foi concluída; um aviso
            enquanto o material válido ainda está sendo servido, um erro após a
            expiração), CERTIFICATE_REVOCATION_FAILED (a revogação não foi
            concluída).
        tags:
          $ref: '#/components/schemas/Tags'
    CertificateStatus:
      description: Erro se e somente se uma falha de gravidade de erro ativa existir.
      type: string
      enum:
        - pending_dns
        - pending
        - active
        - error
        - expired
        - revoked
      example: active
    CertificateChallenge:
      type: object
      required:
        - faults
      properties:
        domain:
          type: string
          description: >-
            O certificado SAN ao qual este desafio pertence (como o cliente o
            escreveu).
          example: '*.example.com'
        cname_record_name:
          type: string
          description: >
            LHS completo do registro CNAME que o cliente precisa adicionar. Para
            SANs curingas, este é o nome pai (`_acme-challenge.example.com.`),
            não o SAN literal — curingas validam em seu pai sob RFC 8555 §8.4.
          example: _acme-challenge.example.com.
        expected_cname:
          type: string
          description: >
            FQDN de destino (RHS do CNAME). Hospedado na zona de validação da
            plataforma, onde o TXT por pedido é publicado durante a emissão.
          example: a1b2c3d4e5f6g7h8.acme.basaltic.cloud.
        our_dns:
          type: boolean
          description: >
            Verdadeiro quando o domínio está hospedado no serviço DNS da
            plataforma e o CNAME foi criado automaticamente. Falso significa que
            o cliente é proprietário da zona e deve adicionar o CNAME no seu
            registrador.
          example: true
        verified:
          type: boolean
          description: >
            True uma vez que o CNAME tenha sido resolvido para expected_cname; a
            emissão de certificados só prossegue quando cada desafio é
            verificado.
          example: true
        verified_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:28:00Z'
        faults:
          type: array
          items:
            $ref: '#/components/schemas/Fault'
          description: >
            A verificação bem-sucedida resolve falhas de verificação enquanto
            retém o histórico. verified registra uma observação bem-sucedida e
            permanece verdadeira se uma renovação posterior observar uma falha
            de DNS. Uma incompatibilidade de CNAME registra
            CERTIFICATE\_DNS\_VERIFICATION\_FAILED como um aviso; verified não
            se move. O histórico interno usa o CRN pai seguido de
            /challenge/<stored-uuid>; nenhum ponto de extremidade separado é
            exposto.
    Fault:
      type: object
      required:
        - code
        - severity
        - message
        - details
        - first_at
        - last_at
        - occurrences
      properties:
        code:
          type: string
          description: >-
            Código estável legível por máquina pertencente à operação de
            relatório.
          example: BACKUP_FAILED
        severity:
          type: string
          enum:
            - error
            - warning
        message:
          type: string
          example: Backup upload failed.
        details:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Contexto estruturado; cadeias de caracteres legadas são preservadas
            em legacy_text.
        first_at:
          type: string
          format: date-time
          description: Primeira observação nesta série de ocorrências ativas.
        last_at:
          type: string
          format: date-time
          description: Última observação nesta série de ocorrências ativas.
        occurrences:
          type: integer
          minimum: 1
          example: 1
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    UnprocessableEntity:
      description: >
        A solicitação está bem formada, mas não pode ser processada conforme
        enviada. Nas operações que aceitam `Idempotency-Key` este é o caso de
        reutilização de chave: a chave foi vista pela primeira vez com uma carga
        de solicitação diferente, então reproduzir o resultado armazenado
        responderia a uma pergunta que o chamador não fez.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: IDEMPOTENCY_KEY_REUSED
              message: >-
                This Idempotency-Key was already used with a different request
                payload
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.