> ## 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.

# Actualizar las comprobaciones de estado, el encuadre o la afinidad de sesión de un grupo de destinos

<Info>
  Requiere la acción de IAM **`loadbalancer:UpdateTargetGroup`**. Consulta [permisos de balanceadores de carga](/loadbalancer/permissions) para obtener la lista completa, lo que cubre cada una y un ejemplo de directiva.
</Info>


## OpenAPI

````yaml /es/api-reference/specs/loadbalancer.yaml patch /v1/target-groups/{id}
openapi: 3.0.3
info:
  title: API de equilibrador de carga basaltico
  version: 1.0.0
  description: >
    Las relaciones de solicitud aceptan referencias clasificadas por sintaxis
    resueltas dentro de la cuenta y región del llamador. Las referencias IP
    flotantes solo aceptan UUID o CRN; los destinos IP permanecen literales.
    Balanceadores de carga administrados: escuchas, grupos de destino,
    comprobaciones de estado y los certificados TLS que termina una escucha.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://loadbalancer.{region}.basaltic.sh
    description: Punto final de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de región
security:
  - BearerAuth: []
paths:
  /v1/target-groups/{id}:
    patch:
      tags:
        - Load Balancers
      summary: >-
        Actualizar las comprobaciones de estado, el encuadre o la afinidad de
        sesión de un grupo de destinos
      operationId: updateTargetGroup
      parameters:
        - name: id
          in: path
          required: true
          description: UUID, CRN o nombre exacto del ámbito de la cuenta
          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: >
        Los nombres se fijan en la creación porque forman el CRN utilizado por
        las directivas de IAM. El envío de nombre en una actualización,
        incluyendo un valor sin cambios, vacío o nulo, devuelve un error de
        validación.
      properties:
        health_check:
          $ref: '#/components/schemas/HealthCheckPatch'
        proxy_protocol:
          type: boolean
          description: >
            Activar el enmarcado PROXY v2 en conexiones ascendentes. Omitir el
            campo deja la configuración actual; establecer true/false lo
            invierte explícitamente.
        session_affinity:
          allOf:
            - $ref: '#/components/schemas/SessionAffinity'
          description: >-
            Reemplaza la configuración de viscosidad. Omitir el campo lo deja
            solo; desactivarlo es un `{"type": "none"}` explícito.
        tags:
          $ref: '#/components/schemas/Tags'
    TargetGroupResponse:
      type: object
      properties:
        target_group:
          $ref: '#/components/schemas/TargetGroup'
    HealthCheckPatch:
      type: object
      description: >
        Combinar los campos suministrados en la comprobación existente. Los
        campos omitidos se conservan; null o un objeto vacío deja la
        comprobación sin cambios. Establezca enabled=false para deshabilitar las
        sondas sin borrar la configuración, y enabled=true para habilitar la
        configuración guardada. Establezca port=0 para usar el puerto de tráfico
        de cada destino; cero tiempos/umbral y un emparejador vacío restablecen
        sus valores predeterminados. Un protocolo vacío hereda el protocolo del
        grupo de destino. Borrar la ruta de una comprobación HTTP/HTTPS
        habilitada explícitamente no es válido.
      properties:
        enabled:
          type: boolean
        protocol:
          $ref: '#/components/schemas/protocol'
        path:
          $ref: '#/components/schemas/path'
        port:
          type: integer
          minimum: 0
          maximum: 65535
          description: Cero elimina la anulación del puerto de la 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: >
        Sesiones fijas: fija un cliente a un backend del grupo en lugar de
        equilibrar cada solicitud de forma independiente. Apagado a menos que lo
        pidas.


        El plano de datos hace hash de la clave de forma consistente, por lo que
        agregar o perder un backend solo mueve a los clientes que ese backend
        estaba sirviendo.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - none
            - cookie
            - source_ip
          default: none
          example: cookie
          description: >
            `none` equilibra cada solicitud. `cookie` establece una cookie opaca
            en la primera respuesta y enruta cada solicitud posterior llevándola
            al mismo backend — solo los grupos http y https. `source_ip` hace un
            hash de la dirección del cliente, funciona en todos los protocolos y
            es la única opción para tcp y udp, pero una puerta de enlace NAT
            hace que cada cliente detrás de ella tenga una sola clave.
        cookie_name:
          type: string
          maxLength: 128
          default: BASALTICLB
          example: BASALTICLB
          description: >-
            Cookie los conjuntos y hashes del balanceador de carga.
            `type=cookie` solamente; el campo se elimina para los otros tipos.
        duration_sec:
          type: integer
          minimum: 1
          maximum: 604800
          default: 86400
          example: 86400
          description: >-
            Cuánto tiempo dura esa cookie, hasta 7 días. `type=cookie`
            solamente.
    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: >-
            Los nombres de los recursos no deben comenzar con el prefijo literal
            crn: ni ser UUID (en cualquier caso, en las formas canónica,
            compacta, entre corchetes o urn:uuid:).
          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: >
            Cuando es true, las conexiones ascendentes se envuelven en el
            encabezado PROXY v2 para que los backends vean la IP + puerto del
            cliente original. Los backends HTTP ya obtienen X-Forwarded-For;
            PROXY es la elección correcta para los grupos objetivo TCP/UDP o
            backends HTTP que prefieren el sobre enmarcado.
        session_affinity:
          $ref: '#/components/schemas/SessionAffinity'
        target_mode:
          type: string
          enum:
            - static
            - pool
          example: static
          description: >
            De dónde proviene el conjunto de backend. `static` enruta a los
            targets adjuntos vía POST /v1/target-groups/{id}/targets; `pool`
            resuelve direcciones de instancias en vivo desde el pool de
            instancias de computación nombrado por instance_pool_id, por lo que
            al escalar el pool se mueven los backends con él.
        instance_pool_id:
          type: string
          format: uuid
          example: a1b2c3d4-e5f6-4789-a0b1-c2d3e4f5a6b7
          description: >-
            Grupo de instancias de cálculo que respalda el grupo. Establezca 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 error que identifica el tipo de error
              example: INVALID_INPUT
            message:
              type: string
              description: Mensaje de error legible por el ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores no sensibles opcionales para la interpolación de errores
                localizados, codificados por código de error. Nunca presente por
                errores del servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuración
              example: 550e8400-e29b-41d4-a716-446655440000
    protocol:
      type: string
      enum:
        - http
        - https
        - tcp
        - udp
        - ''
      description: >-
        Omitida o vacía usa el protocolo de grupo objetivo. UDP utiliza una
        sonda de conexión TCP. Las sondas HTTPS usan TLS.
      example: http
    path:
      type: string
      example: /healthz
    interval_sec:
      type: integer
      minimum: 0
      maximum: 86400
      default: 30
      description: Cero usa el valor predeterminado.
      example: 30
    timeout_sec:
      type: integer
      minimum: 0
      maximum: 86400
      default: 5
      description: Cero usa el valor predeterminado.
      example: 5
    healthy_threshold:
      type: integer
      minimum: 0
      maximum: 100
      default: 3
      description: Cero usa el valor predeterminado.
      example: 3
    unhealthy_threshold:
      type: integer
      minimum: 0
      maximum: 100
      default: 3
      description: Cero usa el valor predeterminado.
      example: 3
    matcher:
      type: string
      default: '200'
      description: >-
        Códigos de estado HTTP de 100 a 599; códigos separados por comas o
        rangos inclusivos. El vacío usa 200.
      example: 200-299,301
    HealthCheck:
      type: object
      description: >
        Las sondas activas están habilitadas de forma predeterminada. Establezca
        enabled=false para detener las sondas mientras mantiene su
        configuración. Una comprobación HTTP/HTTPS habilitada explícitamente
        requiere una ruta de acceso no vacía que comience con /. Las
        comprobaciones TCP se conectan al puerto de comprobación sin una ruta
        HTTP. Los grupos UDP se conectan por defecto a las sondas TCP.
      properties:
        enabled:
          type: boolean
          default: true
        protocol:
          type: string
          enum:
            - http
            - https
            - tcp
            - udp
            - ''
          description: >-
            Omitida o vacía usa el protocolo de grupo objetivo. UDP utiliza una
            sonda de conexión TCP. Las sondas HTTPS usan 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: Cero usa el valor predeterminado.
          example: 30
        timeout_sec:
          type: integer
          minimum: 0
          maximum: 86400
          default: 5
          description: Cero usa el valor predeterminado.
          example: 5
        healthy_threshold:
          type: integer
          minimum: 0
          maximum: 100
          default: 3
          description: Cero usa el valor predeterminado.
          example: 3
        unhealthy_threshold:
          type: integer
          minimum: 0
          maximum: 100
          default: 3
          description: Cero usa el valor predeterminado.
          example: 3
        matcher:
          type: string
          default: '200'
          description: >-
            Códigos de estado HTTP de 100 a 599; códigos separados por comas o
            rangos inclusivos. El vacío usa 200.
          example: 200-299,301
  responses:
    BadRequest:
      description: Parámetros de solicitud no vá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: Se requiere autenticación o el token no es vá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: Permisos 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: No se encontró el recurso
      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: >+
        Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
        <token>`. Esta es la forma recomendada de autenticación.


        Obtén el token intercambiando el par de claves de acceso de una cuenta
        de servicio en `POST /v1/oauth/token` con
        `grant_type=client_credentials`. Es el flujo estándar de credenciales de
        cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar
        el token por ti.


        ```

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


        Los tokens duran una hora por defecto. El mismo par de claves de acceso
        también sirve como credencial AWS SigV4 para el endpoint de objetos
        compatible con S3, que solo acepta ese método de autenticación.


````

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