> ## 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.
# Atualizar um grupo de log
> Mude a descrição, a política de retenção, a associação KMS ou as tags. O nome é imutável (renomear = recriar). Requer `telemetry:UpdateLogGroup`.
Requer a ação do IAM **`telemetry:UpdateLogGroup`**. Consulte [permissões de telemetria](/telemetry/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
## OpenAPI
````yaml /pt/api-reference/specs/telemetry.yaml patch /v1/log-groups/{id}
openapi: 3.0.3
info:
title: API de Telemetria Basaltica
version: 1.0.0
description: >
API de telemetria regional — grupos de log + ingestão/pesquisa de log,
métricas do ClickHouse (remote_write + consulta estruturada com envelopes
JSON compatíveis com Prometheus), ingestão de intervalo e configurações de
pesquisa/detalhes de rastreamento + rastreamento por conta.
As referências de solicitação de grupo de log aceitam UUIDs, CRNs ou nomes
exatos de escopo de conta, classificados por sintaxe sem fallback de
pesquisa. Os CRNs devem corresponder ao identificador de conta autenticado e
à região de atendimento. Os logs HTTP e gRPC OTLP usam basaltic.log_group,
voltando para service.name, com o mesmo contrato de referência.
Identificadores de rastreamento/espaço, rótulos de métrica e dimensões de
pesquisa de região são valores de protocolo, independentes da resolução do
recurso.
contact:
name: Basaltic Support
email: ping@basaltic.sh
license:
name: Proprietary
url: https://basaltic.sh/terms
servers:
- url: https://telemetry.{region}.basaltic.sh
description: Endpoint de API regional (um por região)
variables:
region:
default: sa-saopaulo-1
description: Código de região
security:
- BearerAuth: []
paths:
/v1/log-groups/{id}:
patch:
tags:
- Telemetry
summary: Atualizar um grupo de log
description: >
Mude a descrição, a política de retenção, a associação KMS ou as tags. O
nome é imutável (renomear = recriar). Requer `telemetry:UpdateLogGroup`.
operationId: updateLogGroup
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
example: 4a7b2c8d-9e1f-4a2b-8c3d-5e6f7a8b9c0d
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLogGroupRequest'
responses:
'200':
description: Grupo de log atualizado
content:
application/json:
schema:
$ref: '#/components/schemas/LogGroupResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
components:
schemas:
UpdateLogGroupRequest:
type: object
properties:
description:
type: string
nullable: true
example: Production API request logs (v2)
retention_days:
type: integer
minimum: 1
maximum: 3650
description: 1..3650; passe clear_retention para mudar para nunca expirar
example: 90
clear_retention:
type: boolean
description: >-
Quando true, define a retenção para nunca expirar (ignora
retention_days)
example: false
kms_key:
type: string
description: >-
UUID da chave KMS, CRN ou nome exato na conta autenticada e na
região de atendimento. A omissão preserva o UUID fixado; uma string
vazia limpa a criptografia para registros futuros. Metadados de
chave indisponíveis não limpa a ligação.
nullable: true
example: crn:kms:sa-saopaulo-1:my-account:key/service-key
tags:
type: object
additionalProperties:
type: string
LogGroupResponse:
type: object
properties:
log_group:
$ref: '#/components/schemas/LogGroup'
LogGroup:
type: object
properties:
id:
type: string
format: uuid
example: 4a7b2c8d-9e1f-4a2b-8c3d-5e6f7a8b9c0d
crn:
type: string
description: CRN do grupo de log (usado como o recurso IAM ARN)
example: crn:telemetry:sa-saopaulo-1:my-account:log-group/app-prod-api
account_id:
type: string
format: uuid
description: Conta de proprietário — a cerca de locatário para este grupo
example: 9b2e4d11-6c3a-4f8e-bd47-1a2b3c4d5e6f
name:
type: string
description: >-
1..512 caracteres, [A-Za-z0-9_./#-]. Não é permitido o caractere "/"
à frente. 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: app/prod/api
description:
type: string
example: Production API request logs
retention_days:
type: integer
nullable: true
minimum: 1
maximum: 3650
description: 1..3650 dias, ou null para nunca expirar
example: 30
kms_key_unavailable:
type: boolean
readOnly: true
description: >-
Verdadeiro quando a chave vinculada foi excluída. O CRN é omitido,
mas a ligação permanece criptografada sob sua identidade de chave
original; isso não seleciona criptografia de plataforma ou texto sem
formatação.
kms_key_crn:
type: string
description: >-
CRN da chave KMS. Omitida para texto simples ou quando
kms_key_unavailable é verdadeiro.
example: crn:kms:sa-saopaulo-1:my-account:key/service-key
tags:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
example: '2026-01-15T09:30:00Z'
updated_at:
type: string
format: date-time
example: '2026-01-15T09:30:00Z'
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
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
NotFound:
description: Página não encontrada
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: NOT_FOUND
message: Resource not found
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 `.
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.