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

# Atualizar uma configuração de executor

> Utilize este endpoint para atualizar uma configuração de executor existente. Somente configurações com status `unconfigured` ou `configured` podem ser atualizadas.



## OpenAPI

````yaml pt/openapi/v3-current/flowker.yaml patch /v1/executors/{id}
openapi: 3.1.0
info:
  description: >-
    Referência completa da API para os serviços de orquestração de workflows do
    Flowker, incluindo gerenciamento de catálogo, definições de workflows,
    configurações de executores, configurações de provedores e execuções de
    workflows.
  title: API do Flowker
  version: 1.1.1
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog API
    description: >-
      Explore provedores, executores e gatilhos integrados disponíveis no
      catálogo do Flowker.
  - name: Workflows API
    description: Crie, atualize, ative, desative, clone e exclua definições de workflows.
  - name: Executions API
    description: Inicie execuções de workflows e acompanhe seu status e resultados.
  - name: Executor Configurations API
    description: >-
      Configure, teste e gerencie conexões de executores externos utilizadas
      pelos nós de workflow.
  - name: Provider Configurations API
    description: Configure, teste, habilite e desabilite integrações de provedores.
  - name: Dashboard API
    description: >-
      Recupere resumos agregados de workflows e execuções para dashboards
      operacionais.
  - name: Audit API
    description: >-
      Consulte e verifique eventos de auditoria para conformidade e visibilidade
      operacional.
  - name: Webhooks API
    description: >-
      Receba callbacks de webhooks de sistemas externos para disparar execuções
      de workflows.
paths:
  /v1/executors/{id}:
    patch:
      tags:
        - Executor Configurations API
      summary: Atualizar uma configuração de executor
      description: >-
        Utilize este endpoint para atualizar uma configuração de executor
        existente. Somente configurações com status `unconfigured` ou
        `configured` podem ser atualizadas.
      operationId: updateExecutorConfiguration
      parameters:
        - description: Identificador único da configuração do executor.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExecutorConfigurationInput'
        description: >-
          Corpo da solicitação contendo os detalhes atualizados da configuração
          do executor.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutorConfigurationOutput'
          description: >-
            Indica que a solicitação foi bem-sucedida e a resposta contém os
            dados solicitados.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava malformada ou continha parâmetros
            inválidos.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indica que o recurso solicitado não foi encontrado.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava bem formada, mas contém erros
            semânticos que impedem o processamento.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica um erro interno inesperado. Se persistir, entre em contato
            com o suporte.
components:
  schemas:
    UpdateExecutorConfigurationInput:
      properties:
        authentication:
          $ref: '#/components/schemas/ExecutorAuthenticationInput'
        baseUrl:
          description: URL base do serviço externo.
          example: https://api.serasa.com.br/v2
          maxLength: 500
          type: string
        description:
          description: Descrição legível por humanos desta configuração de executor.
          example: Serasa KYC provider for identity validation
          maxLength: 500
          type: string
        endpoints:
          description: Lista de endpoints HTTP expostos por este executor.
          items:
            $ref: '#/components/schemas/ExecutorEndpointInput'
          minItems: 1
          type: array
        metadata:
          additionalProperties:
            type: object
          description: Pares chave-valor personalizados para etiquetagem.
          type: object
        name:
          description: Nome de exibição da configuração do executor.
          example: Serasa KYC
          maxLength: 100
          minLength: 1
          type: string
      required:
        - authentication
        - baseUrl
        - endpoints
        - name
      type: object
    ExecutorConfigurationOutput:
      example:
        id: b2c3d4e5-f6a7-8901-bcde-f23456789012
        name: Serasa KYC
        description: Serasa identity validation service
        baseUrl: https://api.serasa.com.br/v2
        endpoints:
          - name: validate-identity
            path: /identity/validate
            method: POST
            timeout: 30
        authentication:
          type: api_key
          config:
            key: '********'
            header: X-API-Key
        status: active
        metadata: {}
        createdAt: '2026-03-15T10:00:00Z'
        updatedAt: '2026-03-16T09:30:00Z'
        lastTestedAt: '2026-03-16T09:30:00Z'
      properties:
        authentication:
          $ref: '#/components/schemas/ExecutorAuthenticationOutput'
        baseUrl:
          description: URL base do serviço externo.
          example: https://api.serasa.com.br/v2
          type: string
        createdAt:
          description: Marca temporal de quando a configuração foi criada.
          example: '2026-03-15T10:00:00Z'
          format: date-time
          type: string
        description:
          description: Descrição legível por humanos.
          example: Serasa identity validation service
          type: string
        endpoints:
          description: Lista de endpoints HTTP configurados.
          items:
            $ref: '#/components/schemas/ExecutorEndpointOutput'
          type: array
        id:
          description: Identificador único da configuração do executor.
          example: b2c3d4e5-f6a7-8901-bcde-f23456789012
          format: uuid
          type: string
        lastTestedAt:
          description: >-
            Marca temporal do último teste de conectividade. Nulo se nunca
            testado.
          example: '2026-03-16T09:30:00Z'
          format: date-time
          type: string
        metadata:
          additionalProperties:
            type: object
          description: Metadados personalizados.
          type: object
        name:
          description: Nome de exibição.
          example: Serasa KYC
          type: string
        status:
          description: >-
            Status atual do ciclo de vida: `unconfigured`, `configured`,
            `tested`, `active` ou `disabled`.
          enum:
            - unconfigured
            - configured
            - tested
            - active
            - disabled
          example: active
          type: string
        updatedAt:
          description: Marca temporal da última atualização.
          example: '2026-03-16T09:30:00Z'
          format: date-time
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Código de erro legível por máquina com o prefixo FLK.
          example: FLK-0001
          type: string
        message:
          description: Explicação do erro legível por humanos.
          example: Invalid input provided
          type: string
        title:
          description: Título curto da categoria de erro.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
    ExecutorAuthenticationInput:
      properties:
        config:
          additionalProperties:
            type: object
          description: >-
            Parâmetros de autenticação específicos do tipo escolhido (ex., `key`
            para api_key, `token` para bearer, `username`/`password` para
            basic).
          example:
            key: sk-live-abc123def456
            header: X-API-Key
          type: object
        type:
          description: >-
            Método de autenticação: `none`, `api_key`, `bearer`, `basic`,
            `oidc_client_credentials` ou `oidc_user`.
          enum:
            - none
            - api_key
            - bearer
            - basic
            - oidc_client_credentials
            - oidc_user
          example: api_key
          type: string
      required:
        - type
      type: object
    ExecutorEndpointInput:
      properties:
        method:
          description: Método HTTP para este endpoint.
          enum:
            - GET
            - POST
            - PUT
            - PATCH
            - DELETE
            - HEAD
            - OPTIONS
          example: POST
          type: string
        name:
          description: Nome único para este endpoint dentro do executor.
          example: validate-identity
          maxLength: 50
          minLength: 1
          type: string
        path:
          description: Caminho URL adicionado à URL base do executor.
          example: /identity/validate
          maxLength: 200
          minLength: 1
          type: string
        timeout:
          description: Tempo limite da solicitação em segundos. O padrão é 30.
          example: 30
          maximum: 300
          minimum: 1
          type: integer
      required:
        - method
        - name
        - path
      type: object
    ExecutorAuthenticationOutput:
      properties:
        config:
          additionalProperties:
            type: object
          description: Parâmetros de autenticação. Valores sensíveis são mascarados.
          example:
            key: '********'
            header: X-API-Key
          type: object
        type:
          description: Método de autenticação.
          example: api_key
          type: string
      type: object
    ExecutorEndpointOutput:
      properties:
        method:
          description: Método HTTP.
          example: POST
          type: string
        name:
          description: Nome do endpoint.
          example: validate-identity
          type: string
        path:
          description: Caminho URL.
          example: /identity/validate
          type: string
        timeout:
          description: Tempo limite da solicitação em segundos.
          example: 30
          type: integer
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Chave de API para autenticar as requisições à API do Flowker.
        Provisionada por meio da variável de ambiente API_KEY durante o
        deployment.

````