Update an External Secrets Manager

Updates the configuration of an existing External Secrets Manager instance.

Request schema

Path parameters

esmId

stringrequired

The unique identifier of the External Secrets Manager instance.

example:

lucky_tiger

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

config

objectrequired

Provider-specific configuration object. For AWS_SECRET_MANAGER: role_arn (required). For AZURE_KEY_VAULT: vault_url (required), tenant_id (required for SaaS). For HASHICORP_VAULT: vault_address (required), role_id and secret_id (required for SaaS), namespace (optional).

Http + 1.1

PATCH

https://api.fivetran.com/v1/external-secrets-managers/lucky_tiger

PATCH /v1/external-secrets-managers/lucky_tiger HTTP/1.1
Accept: application/json
Authorization: Basic 
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 18

{
  "config": {}
}

Responses

200

Successful response

400

Validation error

404

External Secrets Manager not found

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Resource updated successfully

data

objectrequired

string

The unique identifier of the External Secrets Manager instance.

example:

lucky_tiger

type

string

The ESM provider type

enum:

"AWS_SECRET_MANAGER""AZURE_KEY_VAULT""HASHICORP_VAULT"

name

string

The name of the ESM instance

example:

My AWS Secrets Manager

config

object

Provider-specific configuration.

property name *

object

additional property

is_hybrid_deployment

boolean

Whether this External Secrets Manager instance is compatible with Hybrid Deployment environments.

example:

true

created_at

string

The timestamp when the ESM instance was created.

format:

date-time

example:

2026-05-20T00:00:00Z

updated_at

string

The timestamp when the ESM instance was last updated.

format:

date-time

example:

2026-05-20T00:00:00Z

{
  "code": "Success",
  "message": "Resource updated successfully",
  "data": {
    "id": "lucky_tiger",
    "type": "AWS_SECRET_MANAGER",
    "name": "My AWS Secrets Manager",
    "config": {
      "property1": {},
      "property2": {}
    },
    "is_hybrid_deployment": true,
    "created_at": "2026-05-20T00:00:00Z",
    "updated_at": "2026-05-20T00:00:00Z"
  }
}