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

# Update an Executor Configuration

> Use this endpoint to update an existing executor configuration. Only configurations with `unconfigured` or `configured` status can be updated.



## OpenAPI

````yaml /en/openapi/v3-current/flowker.yaml patch /v1/executors/{id}
openapi: 3.1.0
info:
  description: >-
    Complete API reference for Flowker workflow orchestration services including
    catalog management, workflow definitions, executor configurations, provider
    configurations, and workflow executions.
  title: Flowker API
  version: 1.0.2
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Health API
    description: Health and version endpoints for monitoring the Flowker service.
  - name: Catalog API
    description: >-
      Browse built-in providers, executors, and triggers available in the
      Flowker catalog.
  - name: Workflows API
    description: >-
      Create, update, activate, deactivate, clone, and delete workflow
      definitions.
  - name: Executions API
    description: Start workflow executions and track their status and results.
  - name: Executor Configurations API
    description: >-
      Configure, test, and manage external executor connections used by workflow
      nodes.
  - name: Provider Configurations API
    description: Configure, test, enable, and disable provider integrations.
  - name: Dashboard API
    description: >-
      Retrieve aggregated summaries of workflows and executions for operational
      dashboards.
  - name: Audit API
    description: Query and verify audit events for compliance and operational visibility.
  - name: Webhooks API
    description: >-
      Receive webhook callbacks from external systems to trigger workflow
      executions.
paths:
  /v1/executors/{id}:
    patch:
      tags:
        - Executor Configurations API
      summary: Update an Executor Configuration
      description: >-
        Use this endpoint to update an existing executor configuration. Only
        configurations with `unconfigured` or `configured` status can be
        updated.
      operationId: updateExecutorConfiguration
      parameters:
        - description: Unique identifier of the executor configuration.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExecutorConfigurationInput'
        description: Request body containing the updated executor configuration details.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutorConfigurationOutput'
          description: >-
            Indicates that the request was successful and the response contains
            the requested data.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request was malformed or contained invalid
            parameters.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indicates that the requested resource could not be found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request was well-formed but contains semantic
            errors that prevent processing.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates an unexpected internal error. If this persists, please
            contact support.
components:
  schemas:
    UpdateExecutorConfigurationInput:
      properties:
        authentication:
          $ref: '#/components/schemas/ExecutorAuthenticationInput'
        baseUrl:
          description: Base URL of the external service.
          example: https://api.serasa.com.br/v2
          maxLength: 500
          type: string
        description:
          description: Human-readable description of this executor configuration.
          example: Serasa KYC provider for identity validation
          maxLength: 500
          type: string
        endpoints:
          description: List of HTTP endpoints exposed by this executor.
          items:
            $ref: '#/components/schemas/ExecutorEndpointInput'
          minItems: 1
          type: array
        metadata:
          additionalProperties:
            type: object
          description: Custom key-value pairs for tagging.
          type: object
        name:
          description: Display name for the executor configuration.
          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: Base URL of the external service.
          example: https://api.serasa.com.br/v2
          type: string
        createdAt:
          description: Timestamp when the configuration was created.
          example: '2026-03-15T10:00:00Z'
          format: date-time
          type: string
        description:
          description: Human-readable description.
          example: Serasa identity validation service
          type: string
        endpoints:
          description: List of configured HTTP endpoints.
          items:
            $ref: '#/components/schemas/ExecutorEndpointOutput'
          type: array
        id:
          description: Unique identifier of the executor configuration.
          example: b2c3d4e5-f6a7-8901-bcde-f23456789012
          format: uuid
          type: string
        lastTestedAt:
          description: Timestamp of the last connectivity test. Null if never tested.
          example: '2026-03-16T09:30:00Z'
          format: date-time
          type: string
        metadata:
          additionalProperties:
            type: object
          description: Custom metadata.
          type: object
        name:
          description: Display name.
          example: Serasa KYC
          type: string
        status:
          description: >-
            Current lifecycle status: `unconfigured`, `configured`, `tested`,
            `active`, or `disabled`.
          enum:
            - unconfigured
            - configured
            - tested
            - active
            - disabled
          example: active
          type: string
        updatedAt:
          description: Timestamp of the last update.
          example: '2026-03-16T09:30:00Z'
          format: date-time
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Machine-readable error code with the FLK prefix.
          example: FLK-0001
          type: string
        message:
          description: Human-readable explanation of the error.
          example: Invalid input provided
          type: string
        title:
          description: Short error category title.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
    ExecutorAuthenticationInput:
      properties:
        config:
          additionalProperties:
            type: object
          description: >-
            Authentication parameters specific to the chosen type (e.g., `key`
            for api_key, `token` for bearer, `username`/`password` for basic).
          example:
            key: sk-live-abc123def456
            header: X-API-Key
          type: object
        type:
          description: >-
            Authentication method: `none`, `api_key`, `bearer`, `basic`,
            `oidc_client_credentials`, or `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: HTTP method for this endpoint.
          enum:
            - GET
            - POST
            - PUT
            - PATCH
            - DELETE
            - HEAD
            - OPTIONS
          example: POST
          type: string
        name:
          description: Unique name for this endpoint within the executor.
          example: validate-identity
          maxLength: 50
          minLength: 1
          type: string
        path:
          description: URL path appended to the executor's base URL.
          example: /identity/validate
          maxLength: 200
          minLength: 1
          type: string
        timeout:
          description: Request timeout in seconds. Defaults to 30.
          example: 30
          maximum: 300
          minimum: 1
          type: integer
      required:
        - method
        - name
        - path
      type: object
    ExecutorAuthenticationOutput:
      properties:
        config:
          additionalProperties:
            type: object
          description: Authentication parameters. Sensitive values are masked.
          example:
            key: '********'
            header: X-API-Key
          type: object
        type:
          description: Authentication method.
          example: api_key
          type: string
      type: object
    ExecutorEndpointOutput:
      properties:
        method:
          description: HTTP method.
          example: POST
          type: string
        name:
          description: Endpoint name.
          example: validate-identity
          type: string
        path:
          description: URL path.
          example: /identity/validate
          type: string
        timeout:
          description: Request timeout in seconds.
          example: 30
          type: integer
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authenticating requests to the Flowker API. Provisioned via
        the API_KEY environment variable during deployment.

````