> ## 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 verificações de integridade, enquadramento ou afinidade de sessão de um grupo de destinos

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


## OpenAPI

````yaml /pt/api-reference/specs/loadbalancer.yaml patch /v1/target-groups/{id}
openapi: 3.0.3
info:
  title: API do Basaltic Load Balancer
  version: 1.0.0
  description: >
    Relações de solicitação aceitam referências classificadas por sintaxe
    resolvidas dentro da conta e região do chamador. Referências IP flutuantes
    aceitam somente UUID ou CRN; os alvos IP permanecem literais. Balanceadores
    de carga gerenciados: ouvintes, pools de destino, verificações de
    integridade e os certificados TLS que um ouvinte encerra.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://loadbalancer.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/target-groups/{id}:
    patch:
      tags:
        - Load Balancers
      summary: >-
        Atualizar verificações de integridade, enquadramento ou afinidade de
        sessão de um grupo de destinos
      operationId: updateTargetGroup
      parameters:
        - name: id
          in: path
          required: true
          description: UUID, CRN ou nome exato do escopo da conta
          schema:
            type: string
            example: b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTargetGroupRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetGroupResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    UpdateTargetGroupRequest:
      additionalProperties: false
      type: object
      description: >
        Os nomes são fixos na criação porque formam o CRN usado pelas políticas
        do IAM. Enviar nome em uma atualização, incluindo um valor inalterado,
        vazio ou nulo, retorna um erro de validação.
      properties:
        health_check:
          $ref: '#/components/schemas/HealthCheckPatch'
        proxy_protocol:
          type: boolean
          description: >
            Alternar o enquadramento PROXY v2 em conexões upstream. Omitir o
            campo deixa a configuração atual; definir true/false o inverte
            explicitamente.
        session_affinity:
          allOf:
            - $ref: '#/components/schemas/SessionAffinity'
          description: >-
            Substitui a configuração de aderência. Omitir o campo deixa-o
            sozinho; desligá-lo é um `{"type": "none"}` explícito.
        tags:
          $ref: '#/components/schemas/Tags'
    TargetGroupResponse:
      type: object
      properties:
        target_group:
          $ref: '#/components/schemas/TargetGroup'
    HealthCheckPatch:
      type: object
      description: >
        Mesclar campos fornecidos na verificação existente. Campos omitidos são
        preservados; nulo ou um objeto vazio deixa a verificação inalterada.
        Defina enabled=false para desabilitar sondas sem limpar configurações e
        enabled=true para habilitar a configuração salva. Defina port=0 para
        usar a porta de tráfego de cada destino; zero timing/thresholds e um
        matcher vazio redefinirão seus padrões. Um protocolo vazio herda o
        protocolo do grupo de destino. Limpar o caminho de uma verificação
        HTTP/HTTPS explicitamente habilitada é inválido.
      properties:
        enabled:
          type: boolean
        protocol:
          $ref: '#/components/schemas/protocol'
        path:
          $ref: '#/components/schemas/path'
        port:
          type: integer
          minimum: 0
          maximum: 65535
          description: Zero remove a substituição da porta da sonda.
        interval_sec:
          $ref: '#/components/schemas/interval_sec'
        timeout_sec:
          $ref: '#/components/schemas/timeout_sec'
        healthy_threshold:
          $ref: '#/components/schemas/healthy_threshold'
        unhealthy_threshold:
          $ref: '#/components/schemas/unhealthy_threshold'
        matcher:
          $ref: '#/components/schemas/matcher'
    SessionAffinity:
      type: object
      description: >
        Sessões fixas: fixe um cliente a um backend no grupo em vez de balancear
        cada solicitação de forma independente. Desligado a menos que você peça.


        O plano de dados faz o hash da chave de forma consistente, portanto,
        adicionar ou perder um backend move apenas os clientes que esse backend
        estava servindo.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - none
            - cookie
            - source_ip
          default: none
          example: cookie
          description: >
            `none` balanceia cada solicitação. `cookie` define um cookie opaco
            na primeira resposta e roteia cada solicitação posterior levando-a
            para o mesmo backend — apenas grupos http e https. `source_ip` faz
            um hash do endereço do cliente, funciona em todos os protocolos e é
            a única opção para tcp e udp, mas um gateway NAT faz com que cada
            cliente atrás dele tenha uma única chave.
        cookie_name:
          type: string
          maxLength: 128
          default: BASALTICLB
          example: BASALTICLB
          description: >-
            Cookie os conjuntos e hashes do balanceador de carga. `type=cookie`
            somente; o campo é descartado para os outros tipos.
        duration_sec:
          type: integer
          minimum: 1
          maximum: 604800
          default: 86400
          example: 86400
          description: Quanto tempo esse cookie dura, até 7 dias. `type=cookie` somente.
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    TargetGroup:
      type: object
      required:
        - id
        - crn
        - account_id
        - name
        - protocol
        - target_type
        - port
        - health_check
        - proxy_protocol
        - session_affinity
        - target_mode
        - tags
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4
        crn:
          type: string
          example: crn:loadbalancer:sa-saopaulo-1:my-account:target-group/web-backends
        account_id:
          type: string
          format: uuid
          example: 6f9619ff-8b86-4d01-b42d-00cf4fc964ff
        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: web-targets
        protocol:
          type: string
          enum:
            - http
            - https
            - tcp
            - udp
          example: http
        target_type:
          type: string
          enum:
            - ip
            - instance
            - function
          example: instance
        port:
          type: integer
          minimum: 1
          maximum: 65535
          example: 8080
        health_check:
          $ref: '#/components/schemas/HealthCheck'
        proxy_protocol:
          type: boolean
          example: false
          description: >
            Quando true, as conexões upstream são envoltas no cabeçalho PROXY v2
            para que os backends vejam o IP + porta do cliente original. Os
            backends HTTP já recebem X-Forwarded-For; PROXY é a escolha certa
            para grupos-alvo TCP/UDP ou backends HTTP que preferem o envelope
            enquadrado.
        session_affinity:
          $ref: '#/components/schemas/SessionAffinity'
        target_mode:
          type: string
          enum:
            - static
            - pool
          example: static
          description: >
            De onde vem o conjunto de backend. `static` rotas para os alvos
            anexados via POST /v1/target-groups/{id}/targets; `pool` resolve
            endereços de instância ativa do pool de instância de computação
            nomeado por instance_pool_id, então escalar o pool move os backends
            com ele.
        instance_pool_id:
          type: string
          format: uuid
          example: a1b2c3d4-e5f6-4789-a0b1-c2d3e4f5a6b7
          description: >-
            Pool de instâncias de computação que suporta o grupo. Defina iff
            target_mode=pool.
        tags:
          $ref: '#/components/schemas/Tags'
        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
    protocol:
      type: string
      enum:
        - http
        - https
        - tcp
        - udp
        - ''
      description: >-
        Omitida ou vazia usa o protocolo do grupo de destino. UDP usa uma sonda
        de conexão TCP. As sondas HTTPS usam TLS.
      example: http
    path:
      type: string
      example: /healthz
    interval_sec:
      type: integer
      minimum: 0
      maximum: 86400
      default: 30
      description: Zero usa o padrão.
      example: 30
    timeout_sec:
      type: integer
      minimum: 0
      maximum: 86400
      default: 5
      description: Zero usa o padrão.
      example: 5
    healthy_threshold:
      type: integer
      minimum: 0
      maximum: 100
      default: 3
      description: Zero usa o padrão.
      example: 3
    unhealthy_threshold:
      type: integer
      minimum: 0
      maximum: 100
      default: 3
      description: Zero usa o padrão.
      example: 3
    matcher:
      type: string
      default: '200'
      description: >-
        Códigos de status HTTP de 100 a 599; códigos separados por vírgulas ou
        intervalos inclusivos. Empty usa 200.
      example: 200-299,301
    HealthCheck:
      type: object
      description: >
        As sondas ativas são habilitadas por padrão. Defina enabled=false para
        parar as sondas enquanto mantém sua configuração. Uma verificação
        HTTP/HTTPS explicitamente habilitada requer um caminho não vazio
        começando com /. As verificações TCP conectam-se à porta de verificação
        sem um caminho HTTP. Os grupos UDP são padrão para sondas de conexão
        TCP.
      properties:
        enabled:
          type: boolean
          default: true
        protocol:
          type: string
          enum:
            - http
            - https
            - tcp
            - udp
            - ''
          description: >-
            Omitida ou vazia usa o protocolo do grupo de destino. UDP usa uma
            sonda de conexão TCP. As sondas HTTPS usam TLS.
          example: http
        path:
          type: string
          example: /healthz
        port:
          type: integer
          minimum: 1
          maximum: 65535
          example: 8080
        interval_sec:
          type: integer
          minimum: 0
          maximum: 86400
          default: 30
          description: Zero usa o padrão.
          example: 30
        timeout_sec:
          type: integer
          minimum: 0
          maximum: 86400
          default: 5
          description: Zero usa o padrão.
          example: 5
        healthy_threshold:
          type: integer
          minimum: 0
          maximum: 100
          default: 3
          description: Zero usa o padrão.
          example: 3
        unhealthy_threshold:
          type: integer
          minimum: 0
          maximum: 100
          default: 3
          description: Zero usa o padrão.
          example: 3
        matcher:
          type: string
          default: '200'
          description: >-
            Códigos de status HTTP de 100 a 599; códigos separados por vírgulas
            ou intervalos inclusivos. Empty usa 200.
          example: 200-299,301
  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
  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.