---
title: "Update an Executor Configuration"
method: PATCH
path: "/v1/executors/{id}"
tags: ["Executor Configurations API"]
---

# Update an Executor Configuration

`PATCH /v1/executors/{id}`

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

## Path parameters

- `id` string, uuid, required

## Request body

- UpdateExecutorConfigurationInput
  - `authentication` ExecutorAuthenticationInput, required
    - `config` object — Authentication parameters specific to the chosen type (e.g., `key` for api_key, `token` for bearer, `username`/`password` for basic).
    - `type` 'none' | 'api_key' | 'bearer' | 'basic' | 'oidc_client_credentials' | 'oidc_user', required — Authentication method: `none`, `api_key`, `bearer`, `basic`, `oidc_client_credentials`, or `oidc_user`.
  - `baseUrl` string, required — Base URL of the external service.
  - `description` string — Human-readable description of this executor configuration.
  - `endpoints` ExecutorEndpointInput[], required — List of HTTP endpoints exposed by this executor.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS', required — HTTP method for this endpoint.
    - `name` string, required — Unique name for this endpoint within the executor.
    - `path` string, required — URL path appended to the executor's base URL.
    - `timeout` integer — Request timeout in seconds. Defaults to 30.
  - `metadata` object — Custom key-value pairs for tagging.
  - `name` string, required — Display name for the executor configuration.

## Response `200`

Indicates that the request was successful and the response contains the requested data.

- ExecutorConfigurationOutput
  - `authentication` ExecutorAuthenticationOutput
    - `config` object — Authentication parameters. Sensitive values are masked.
    - `type` string — Authentication method.
  - `baseUrl` string — Base URL of the external service.
  - `createdAt` string, date-time — Timestamp when the configuration was created.
  - `description` string — Human-readable description.
  - `endpoints` ExecutorEndpointOutput[] — List of configured HTTP endpoints.
    - `method` string — HTTP method.
    - `name` string — Endpoint name.
    - `path` string — URL path.
    - `timeout` integer — Request timeout in seconds.
  - `id` string, uuid — Unique identifier of the executor configuration.
  - `lastTestedAt` string, date-time — Timestamp of the last connectivity test. Null if never tested.
  - `metadata` object — Custom metadata.
  - `name` string — Display name.
  - `status` 'unconfigured' | 'configured' | 'tested' | 'active' | 'disabled' — Current lifecycle status: `unconfigured`, `configured`, `tested`, `active`, or `disabled`.
  - `updatedAt` string, date-time — Timestamp of the last update.

## Other responses

- `400` — Indicates that the request was malformed or contained invalid parameters.
- `404` — Indicates that the requested resource could not be found.
- `422` — Indicates that the request was well-formed but contains semantic errors that prevent processing.
- `500` — Indicates an unexpected internal error. If this persists, please contact support.

---

[API](https://skmtc.net/lerian/apis/identity-plugin.md) · [All operations](https://skmtc.net/lerian/apis/identity-plugin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lerian/identity-plugin/versions/25daba385532/schema)
