Returns a list of all proxy agents within your Fivetran account.
List all Proxy Agents
Request schema
Query parameters
cursor
string
Paging cursor, read more about pagination
example:
limit
integer
Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.
format:
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Http + 1.1
GET
https://api.fivetran.com/v1/proxy
GET /v1/proxy?cursor=eyJza2lwIjoyfQ&limit=100 HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com
Responses
200
Successful response
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
items
arrayrequired
The collection of return items
id
string
The unique identifier for the proxy agent within the Fivetran system.
example:
account_id
string
Fivetran Account ID.
example:
registered_at
string
The timestamp of the time the proxy agent was created in your account.
format:
example:
region
string
Data processing location. This is where Fivetran will operate and run computation on data.
enum:
created_by
string
The actor who created the proxy agent.
example:
display_name
string
Proxy agent name.
example:
nextCursor
string
The value of the cursor parameter for the next page
example:
{
"code": "Success",
"message": "Operation performed.",
"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"
}
],
"nextCursor": "cursor_value"
}
}