List All Connections Attached to the Proxy Agent

Returns all connections attached to the specified proxy agent within your Fivetran account.

Request schema

Path parameters

agentId

stringrequired

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

example:

agentId

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

GET /v1/proxy/agentId/connections?cursor=cursor_value&limit=100 HTTP/1.1
Accept: application/json
Authorization: Basic 
Host: api.fivetran.com

Responses

200

Successful response

404

Proxy Agent not found

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Proxy agent connections retrieved successfully

data

undefinedrequired

items

arrayrequired

The collection of returned items

connection_id

string

The unique identifier for the connection within the Fivetran system.

example:

connection_id

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Proxy agent connections retrieved successfully",
  "data": {
    "items": [
      {
        "connection_id": "connection_id"
      }
    ],
    "next_cursor": "cursor_value"
  }
}