List Entities Using an External Secrets Manager

Returns a list of source connections and destinations that are using a specific External Secrets Manager.

Request schema

Path parameters

esmId

stringrequired

The unique identifier of the External Secrets Manager instance within the Fivetran system.

example:

lucky_tiger

Query parameters

type

string

Filter by entity type. Accepted values are source, destination, or all.

example:

source

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

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

GET /v1/external-secrets-managers/lucky_tiger/entities?type=source HTTP/1.1
Accept: application/json
Authorization: Basic 
Host: api.fivetran.com

Responses

200

Successful response

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed successfully

data

undefinedrequired

items

arrayrequired

The collection of returned items

string

The unique identifier of the source connection or destination.

example:

connection_id

type

string

The type of entity using this External Secrets Manager. Possible values: SOURCE, DESTINATION.

enum:

"SOURCE""DESTINATION"

name

string

The schema name of the source connection, or the name of the destination group.

example:

my_schema

enabled

boolean

Whether the source connection or destination is currently active and connected.

example:

true

secret_manager_id

string

The unique identifier of the External Secrets Manager instance within the Fivetran system.

example:

lucky_tiger

created_at

string

Timestamp when the entity was created

format:

date-time

example:

2024-01-01T00:00:00Z

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Operation performed successfully",
  "data": {
    "items": [
      {
        "id": "connection_id",
        "type": "SOURCE",
        "name": "my_schema",
        "enabled": true,
        "secret_manager_id": "lucky_tiger",
        "created_at": "2024-01-01T00:00:00Z"
      }
    ],
    "next_cursor": "cursor_value"
  }
}