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

# Criar destino SIEM

> Gerenciar destinos de entrega de auditoria protegidos e com escopo de ambiente.

> [!NOTE]
>
> Verifique `delivery_available` na resposta da lista antes de habilitar um destino. A entrega cobre novos eventos de auditoria com atribuição de ambiente verificada. Eventos históricos e não atribuídos não são transmitidos. Um destino `enabled` não é evidência de ingestão bem-sucedida; inspecione `delivery_counts` e seu receptor.

Use a chave de API para o ambiente de sandbox ou produção pretendido. A listagem requer `audit:read`; as alterações requerem `audit:write`. Uma sessão de navegador deve pertencer a um administrador do espaço de trabalho. Um destino de outro locatário ou ambiente não pode ser atualizado ou excluído.

As credenciais são criptografadas em repouso e nunca aparecem nas respostas. Para webhooks, forneça `secret`; para Splunk, Datadog ou Elastic, forneça `token`. Alterar um endpoint requer o fornecimento de sua credencial novamente. A configuração do CloudWatch não é suportada.

Um ambiente pode conter até 20 destinos. A exclusão de um destino remove as suas credenciais guardadas e os registos de entrega em fila. Desativar ou alterar um destino cancela as suas entregas pendentes; guarde qualquer evidência de entrega de que precise primeiro.

Consulte o [guia de entrega SIEM](https://docs.truthlocks.com/pt/guides/siem-integration.md) para retentativas, configurações do provedor e verificação de webhook. Para ingestão de snapshot, use [exportações de auditoria](https://docs.truthlocks.com/pt/api-reference/audit/export.md) ou [exportações de eventos de risco](https://docs.truthlocks.com/pt/api-reference/risk/exports/create.md). Essas exportações não permitem streaming contínuo.


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/audit/siem
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >-
    Truthlocks é uma infraestrutura de verificação universal para documentos,
    credenciais e ativos digitais.

    Esta especificação define a API canônica para interagir com os serviços
    Truthlocks.


    ## URLs Base

    - **Produção**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Autenticação

    - **Chaves de API**: Use o cabeçalho `X-API-Key` para operações máquina a
    máquina

    - **Tokens de Portador**: Use `Authorization: Bearer <jwt>` para operações
    iniciadas pelo usuário


    ## Identidade do Inquilino

    Em produção, a identidade do inquilino é derivada do contexto autenticado
    (chave de API ou JWT).

    O cabeçalho `X-Tenant-ID` é ignorado em produção para evitar falsificação.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de Produção
  - url: https://sandbox-api.truthlocks.com
    description: Ambiente Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gerenciamento de chaves e tokens de API
  - name: Issuers
    description: Registro do emissor e gerenciamento de confiança
  - name: Keys
    description: Gerenciamento de chaves criptográficas para emissores
  - name: Attestations
    description: Ciclo de vida da atestação (cunhar, revogar, substituir)
  - name: Verification
    description: Verificação de atestado e pacotes de prova
  - name: Governance
    description: Fluxos de trabalho de governança do emissor (somente administrador)
  - name: Identity
    description: Gerenciamento de organização, usuário e função
  - name: Audit
    description: Consultas de eventos de auditoria
  - name: Tenant Console
    description: Endpoints de perfil e ciclo de vida do locatário
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Risk
    description: Ingestão de sinal de risco e detecção de fraude
  - name: Risk Enforcement
    description: Ações de aplicação de risco — bloqueio, desafio, quarentena e configuração
  - name: Billing
    description: Gerenciamento de faturamento, assinatura e complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidade de Agente de Máquina (MAIP) — registro de agente,
      sessões, confiança, testemunha, conformidade, orquestração e
      observabilidade
externalDocs:
  description: API somente leitura de transparência (especificação de serviço separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/audit/siem:
    post:
      tags:
        - Audit
      summary: Criar destino SIEM
      description: >-
        Gerenciar a configuração de destino SIEM salva no ambiente de espaço de
        trabalho autenticado. Novos eventos de auditoria com atribuição de
        ambiente verificada podem ser entregues quando delivery_available for
        verdadeiro. Eventos históricos ou não atribuídos não são transmitidos; a
        ativação não é prova de ingestão bem-sucedida. As credenciais são
        criptografadas em repouso e nunca são retornadas. As chaves de API
        exigem audit:read para listagem ou audit:write para alterações; as
        sessões do navegador exigem acesso de administrador do espaço de
        trabalho.
      operationId: createSiemDestination
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - provider
                - endpoint
              properties:
                provider:
                  type: string
                  description: Tipo de provedor SIEM.
                  enum:
                    - splunk
                    - datadog
                    - elastic
                    - webhook
                endpoint:
                  type: string
                  format: uri
                  description: >-
                    Nome de host HTTPS público na porta 443, sem credenciais de
                    usuário, parâmetros de consulta ou fragmento. Alterar o
                    endpoint requer fornecer a credencial novamente. Salvar não
                    valida a propriedade ou a entrega.
                  maxLength: 2048
                token:
                  type: string
                  description: >-
                    Token para configuração Splunk, Datadog ou Elastic.
                    Necessário na criação para esses provedores. Não forneça o
                    segredo também.
                  writeOnly: true
                  minLength: 16
                  maxLength: 8192
                secret:
                  type: string
                  description: >-
                    Segredo compartilhado para configuração de webhook.
                    Obrigatório na criação para webhook. Não forneça token
                    também.
                  writeOnly: true
                  minLength: 16
                  maxLength: 8192
                enabled:
                  type: boolean
                  default: false
                  description: >-
                    Habilita a entrega de eventos de auditoria recém-registrados
                    atribuídos ao ambiente. Requer delivery_available=true; caso
                    contrário, true retorna 409. O padrão é false ao criar um
                    destino.
              additionalProperties: false
              example:
                provider: webhook
                endpoint: https://logs.example.com/ingest
                secret: replace-with-a-random-secret
                enabled: false
      responses:
        '201':
          description: Destino SIEM criado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  environment_id:
                    type: string
                    format: uuid
                  provider:
                    type: string
                    enum:
                      - splunk
                      - datadog
                      - elastic
                      - webhook
                  endpoint:
                    type: string
                    format: uri
                  enabled:
                    type: boolean
                  status:
                    type: string
                    enum:
                      - configured_delivery_unavailable
                      - disabled
                      - enabled
                  credential_configured:
                    type: boolean
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
        '400':
          description: >-
            Configuração inválida, campos não suportados, tipo de credencial ou
            identificador.
        '401':
          description: Não autorizado
        '403':
          description: >-
            É necessário acesso de administrador de escopo de auditoria
            aplicável ou espaço de trabalho.
        '404':
          description: Destino não encontrado no ambiente de workspace autenticado.
        '409':
          description: >-
            Entrega indisponível ou o limite de ambiente de 20 destinos
            atingido.
        '500':
          description: >-
            A configuração não pôde ser lida ou persistida; nenhum sucesso é
            afirmado.
      security:
        - APIKey: []
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de API para autenticação máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operações iniciadas pelo usuário

````

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