Proxy Agent Management BETA
Our REST API supports the following proxy agent management actions:
- Create a Proxy Agent
- List all Proxy Agents
- Retrieve Proxy Agent Details
- Delete a Proxy Agent
- Return all connections attached to the proxy agent
Create a Proxy Agent
Creates a new proxy agent within your Fivetran account.
Request
POST https://api.fivetran.com/v1/proxy
{
"display_name": "string",
"group_region": "string"
}
Payload parameters
Name | Description | Possible Values |
---|---|---|
display_name (required) | The proxy agent name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. | |
group_region (required) | Data processing location. This is where Fivetran will operate and run computation on data. | 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 ,AWS_US_EAST_1 ,AWS_US_EAST_2 ,AWS_US_WEST_2 ,AWS_AP_NORTHEAST_1 ,AWS_AP_SOUTHEAST_1 ,AWS_AP_SOUTHEAST_2 ,AWS_EU_CENTRAL_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 . The default value is GCP_US_EAST4 . |
Response
HTTP 201 CREATED
{
"code": "Success",
"data": {
"agent_id": "string",
"auth_token": "string",
"proxy_server_uri": "string"
}
}
Name | Description |
---|---|
id | The unique identifier for the proxy agent within the Fivetran system. |
auth_token | The auth token. |
proxy_server_uri | The proxy server URI. |
HTTP 400 BAD REQUEST
Not supported group region.
HTTP 409 CONFLICT
Proxy agent with same name already exists.
List all Proxy Agents
Returns a list of all proxy agents within your Fivetran account.
Request
GET https://api.fivetran.com/v1/proxy
Query parameters
Name | Description |
---|---|
cursor | The paging cursor, read more about pagination |
limit | The number of records to fetch per page, accepts a number in the range 1..1000, the default value is 100 |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "string",
"account_id": "string",
"registered_at": "string",
"region": "string",
"created_by": "string",
"display_name": "string"
}
],
"next_cursor": "eyJza2lwIjoyfQ"
}
}
Fields
Name | Description |
---|---|
items | The collection of proxy agents |
next_cursor | The value of the cursor parameter for the next page |
Retrieve Proxy Agent Details
Retrieves the details of the specified proxy agent.
Request
GET https://api.fivetran.com/v1/proxy/{agent_id}
Path parameters
Name | Description |
---|---|
agent_id (required) | The unique identifier for the proxy agent within your Fivetran account. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "string",
"account_id": "string",
"registered_at": "string",
"region": "string",
"created_by": "string",
"display_name": "string"
}
}
Name | Description | Possible values |
---|---|---|
id | The unique identifier for the proxy agent within the Fivetran system. | |
account_id | Fivetran Account ID. | |
registered_at | The timestamp of the time the proxy agent was created in your account. | |
group_region | Data processing location. This is where Fivetran will operate and run computation on data. | 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 ,AWS_US_EAST_1 ,AWS_US_EAST_2 ,AWS_US_WEST_2 ,AWS_AP_NORTHEAST_1 ,AWS_AP_SOUTHEAST_1 ,AWS_AP_SOUTHEAST_2 ,AWS_EU_CENTRAL_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 . The default value is GCP_US_EAST4 . |
created_by | The actor who created the proxy agent. | |
display_name | The proxy agent name within the account. |
HTTP 404 NOT_FOUND
Proxy agent with agent_id
not found.
Delete a Proxy Agent
Deletes the specified proxy agent from your Fivetran account.
Request
DELETE https://api.fivetran.com/v1/proxy/{agent_id}
Path parameters
Name | Description |
---|---|
agent_id (required) | The unique identifier for the proxy agent within your Fivetran account. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "string"
}
HTTP 400 BAD REQUEST
Error during removal process.
HTTP 404 NOT_FOUND
Proxy agent with agent_id
not found.
HTTP 409 CONFLICT
Proxy agent with agent_id
have attached connections.
Return all connections attached to the proxy agent
Returns all connections attached to the specified proxy agent within your Fivetran account.
Request
GET https://api.fivetran.com/v1/proxy/{agent_id}/connections
Path parameters
Name | Description |
---|---|
agent_id (required) | The unique identifier for the proxy agent within your Fivetran account. |
Query parameters
Name | Description |
---|---|
cursor | The paging cursor, read more about pagination |
limit | The number of records to fetch per page, accepts a number in the range 1..1000, the default value is 100 |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"connection_id": "string"
}
],
"next_cursor": "eyJza2lwIjoyfQ"
}
}
Fields
Name | Description |
---|---|
items | The collection of proxy agents |
next_cursor | The value of the cursor parameter for the next page |