List all Proxy Agents

Returns a list of all proxy agents within your Fivetran account.

Request schema

Query parameters

cursor

string

Paging cursor, read more about pagination

example:

cursor_value

limit

integer

Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

format:

int32

example:

100

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/proxy

GET /v1/proxy?cursor=cursor_value&limit=100 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:

Proxy agent retrieved successfully

data

undefinedrequired

items

arrayrequired

The collection of returned items

string

The unique identifier for the proxy agent within the Fivetran system.

example:

account_id

string

Fivetran Account ID.

example:

account_id

registered_at

string

The timestamp of the time the proxy agent was created in your account.

format:

date-time

example:

2018-12-01T15:43:29.013729Z

region

string

Data processing location. This is where Fivetran will operate and run computation on data.

enum:

"GCP_US_EAST4""GCP_US_WEST1""GCP_US_CENTRAL1""GCP_EUROPE_WEST3""GCP_AUSTRALIA_SOUTHEAST1""GCP_NORTHAMERICA_NORTHEAST1""GCP_EUROPE_WEST2""GCP_ASIA_SOUTHEAST1""GCP_ASIA_SOUTHEAST2""GCP_ASIA_SOUTH1""GCP_ASIA_NORTHEAST1""GCP_ASIA_NORTHEAST3""GCP_ME_CENTRAL2""AWS_US_EAST_1""AWS_US_EAST_2""AWS_US_WEST_2""AWS_AP_NORTHEAST_1""AWS_AP_NORTHEAST_2""AWS_AP_SOUTHEAST_1""AWS_AP_SOUTHEAST_2""AWS_EU_CENTRAL_1""AWS_EU_NORTH_1""AWS_EU_WEST_1""AWS_EU_WEST_2""AWS_AP_SOUTH_1""AWS_CA_CENTRAL_1""AWS_US_GOV_WEST_1""AZURE_EASTUS2""AZURE_AUSTRALIAEAST""AZURE_UKSOUTH""AZURE_WESTEUROPE""AZURE_CENTRALUS""AZURE_CANADACENTRAL""AZURE_UAENORTH""AZURE_SOUTHEASTASIA""AZURE_EASTUS""AZURE_JAPANEAST""AZURE_CENTRALINDIA""AZURE_GERMANYWESTCENTRAL""AZURE_WESTUS3""AZURE_SWITZERLANDNORTH""AZURE_KOREACENTRAL"

created_by

string

The actor who created the proxy agent.

example:

created_by

display_name

string

Proxy agent name.

example:

display_name

version

string

The version of the proxy agent.

example:

1.0.0

status

string

The connection status of the proxy agent.

enum:

"NOT_FOUND""CONNECTED""NOT_CONNECTED"

connector_count

integer

The number of source connections using the proxy agent.

format:

int32

example:

destination_count

integer

The number of destinations using the proxy agent.

format:

int32

example:

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Proxy agent retrieved successfully",
  "data": {
    "items": [
      {
        "id": "id",
        "account_id": "account_id",
        "registered_at": "2018-12-01T15:43:29.013729Z",
        "region": "GCP_US_EAST4",
        "created_by": "created_by",
        "display_name": "display_name",
        "version": "1.0.0",
        "status": "CONNECTED",
        "connector_count": 3,
        "destination_count": 1
      }
    ],
    "next_cursor": "cursor_value"
  }
}