Creates a new proxy agent within your Fivetran account.
Create a Proxy Agent
Request schema
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Request
display_name
string
Proxy agent name.
example:
group_region
string
Data processing location. This is where Fivetran will operate and run computation on data.
enum:
Http + 1.1
POST
https://api.fivetran.com/v1/proxy
POST /v1/proxy HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 70
{
"display_name": "display_name",
"group_region": "GCP_US_EAST4"
}Responses
201
Successful response
400
Group region not supported
409
Proxy agent with same name already exists.
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
client_cert
string
agent_id
string
The unique identifier for the proxy agent within the Fivetran system.
example:
proxy_server_uri
string
The proxy server URI.
example:
auth_token
string
The auth token.
example:
client_private_key
string
{
"code": "Created",
"message": "Operation performed.",
"data": {
"client_cert": "string",
"agent_id": "id",
"proxy_server_uri": "proxy_server_uri",
"auth_token": "auth_token",
"client_private_key": "string"
}
}