Create an External Secrets Manager

Creates a new External Secrets Manager instance within your Fivetran account.

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

type

stringrequired

The ESM provider type. Supported values: AWS_SECRET_MANAGER, AZURE_KEY_VAULT, HASHICORP_VAULT.

enum:

"AWS_SECRET_MANAGER""AZURE_KEY_VAULT""HASHICORP_VAULT"

name

stringrequired

The name of the External Secrets Manager instance. Must be unique within the account.

example:

My AWS Secrets Manager

config

objectrequired

is_hybrid_deployment

boolean

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

Http + 1.1

POST

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

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

{
  "type": "AWS_SECRET_MANAGER",
  "name": "My AWS Secrets Manager",
  "config": {},
  "is_hybrid_deployment": false
}

Responses

201

Successful response

400

Validation error

`201`

code

stringrequired

Response status code

example:

Created

message

string

Response status text

example:

External Secrets Manager has been created

data

objectrequired

Response containing External Secrets Manager instance details

string

The unique identifier of the ESM instance

type

string

The type of ESM

enum:

"AZURE_KEY_VAULT""GOOGLE_SECRET_MANAGER""AWS_SECRET_MANAGER""HASHICORP_VAULT"

name

string

The name of the ESM instance

config

object

Provider-specific configuration

property name *

object

additional property

description:

Provider-specific configuration

created_at

string

Timestamp when the ESM instance was created

format:

date-time

is_hybrid_deployment_compatible

boolean

Whether this ESM is compatible with hybrid deployment environments

updated_at

string

Timestamp when the ESM instance was last updated

format:

date-time

{
  "code": "Created",
  "message": "External Secrets Manager has been created",
  "data": {
    "id": "string",
    "type": "AZURE_KEY_VAULT",
    "name": "string",
    "config": {
      "property1": {},
      "property2": {}
    },
    "created_at": "2019-08-24T14:15:22Z",
    "is_hybrid_deployment_compatible": true,
    "updated_at": "2019-08-24T14:15:22Z"
  }
}