Proxy Agent Managementlink
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
- Attach connection to the proxy agent
- Detach connection from the proxy agent
Create a Proxy Agentlink
Creates a new proxy agent within your Fivetran account.
Requestlink
POST https://api.fivetran.com/v1/proxy
{
"display_name": "string",
"group_id": "string"
}
Payload parameterslink
Name | Description |
---|---|
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_id (required) | The unique identifier for the group within the Fivetran system. |
Responselink
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 404 NOT_FOUND
Group with group_id
not found.
HTTP 409 CONFLICT
Proxy agent with same name already exists.
List all Proxy Agentslink
Returns a list of all proxy agents within your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/proxy
Query parameterslink
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 |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "string",
"account_id": "string",
"registred_at": "string",
"region": "string",
"token": "string",
"salt": "string",
"created_by": "string",
"display_name": "string"
}
],
"next_cursor": "eyJza2lwIjoyfQ"
}
}
Fieldslink
Name | Description |
---|---|
items | The collection of proxy agents |
next_cursor | The value of the cursor parameter for the next page |
Retrieve Proxy Agent Detailslink
Retrieves the details of the specified proxy agent.
Requestlink
GET https://api.fivetran.com/v1/proxy/{agent_id}
Path parameterslink
Name | Description |
---|---|
agent_id (required) | The unique identifier for the proxy agent within your Fivetran account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "string",
"account_id": "string",
"registred_at": "string",
"region": "string",
"token": "string",
"salt": "string",
"created_by": "string",
"display_name": "string"
}
}
Name | Description |
---|---|
id | The unique identifier for the proxy agent within the Fivetran system. |
account_id | Fivetran Account ID. |
registred_at | The timestamp of the time the proxy agent was created in your account. |
region | Data processing location. This is where Fivetran will operate and run computation on data. |
token | The auth token. |
salt | The salt. |
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 Agentlink
Deletes the specified proxy agent from your Fivetran account.
Requestlink
DELETE https://api.fivetran.com/v1/proxy/{agent_id}
Path parameterslink
Name | Description |
---|---|
agent_id (required) | The unique identifier for the proxy agent within your Fivetran account. |
Responselink
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 agentlink
Returns all connections attached to the specified proxy agent within your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/proxy/{agent_id}/connections
Path parameterslink
Name | Description |
---|---|
agent_id (required) | The unique identifier for the proxy agent within your Fivetran account. |
Query parameterslink
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 |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"connection_id": "string"
}
],
"next_cursor": "eyJza2lwIjoyfQ"
}
}
Fieldslink
Name | Description |
---|---|
items | The collection of proxy agents |
next_cursor | The value of the cursor parameter for the next page |
Attach connection to the proxy agentlink
Attaches the specified connection to the specified proxy agent within your Fivetran account.
Requestlink
POST https://api.fivetran.com/v1/proxy/{agent_id}/connections
{
"connection_id": "string"
}
Path parameterslink
Name | Description |
---|---|
agent_id (required) | The unique identifier for the proxy agent within your Fivetran account. |
Payload parameterslink
Name | Description |
---|---|
connection_id (required) | The unique identifier for the connection within the Fivetran system. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "string"
}
HTTP 400 BAD REQUEST
Proxy agent region and connection region mismatch.
HTTP 404 NOT_FOUND
Proxy agent with agent_id
or connection with connection_id
not found.
Detach connection from the proxy agentlink
Detaches the specified connection from the specified proxy agent.
Requestlink
DELETE https://api.fivetran.com/v1/proxy/{agent_id}/connections/{connection_id}
Path parameterslink
Name | Description |
---|---|
agent_id (required) | The unique identifier for the proxy agent within your Fivetran account. |
connection_id (required) | The unique identifier for the connection within the Fivetran system. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "string"
}
HTTP 404 NOT_FOUND
Proxy agent with agent_id
or connection with connection_id
not found.