Retrieve Proxy Agent Details

Retrieves the details of the specified proxy agent.

Request schema

Path parameters

agentId

stringrequired

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

example:

agentId

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

GET /v1/proxy/agentId HTTP/1.1
Accept: application/json
Authorization: Basic 
Host: api.fivetran.com

Responses

200

Successful response

404

Proxy Agent not found

`200`

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"

usage

array

List of source connections and destinations using this proxy agent.

string

The unique identifier for either source connection or destination within the Fivetran system.

example:

two_words

schema

string

The schema name of the source connection. Null for destinations.

example:

schema

service

string

Source connector service or connection destination type.

example:

service

{
  "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",
  "usage": [
    {
      "id": "two_words",
      "schema": "schema",
      "service": "service"
    }
  ]
}