Create a Hybrid Deployment Agent
Creates a new Hybrid Deployment Agent in a group.
Request schema
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Request
accept_terms
booleanrequired
Boolean, must be true to indicate that the caller accepts the Fivetran On-Prem Software License Addendum.
example:
auth_type
string
enum:
display_name
stringrequired
Hybrid Deployment Agent display name.
example:
env_type
stringrequired
Environment type. (docker)
enum:
group_id
stringrequired
The unique identifier for the group within your Fivetran account.
example:
Http + 1.1
POST
https://api.fivetran.com/v1/hybrid-deployment-agents
POST /v1/hybrid-deployment-agents HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 133
{
"accept_terms": true,
"auth_type": "AUTO",
"display_name": "display_name",
"env_type": "DOCKER",
"group_id": "group_id"
}Responses
201
Successful response
400
Missing name or license not accepted in the payload.
404
Group not found.
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
id
stringrequired
The unique ID of a Hybrid Deployment Agent.
example:
files
object
config_json
arrayrequired
Base64 encoded content of the config.json
example:
type:
docker_compose_yaml
arrayrequired
Base64 encoded content of the docker-compose.yaml
example:
type:
auth_json
arrayrequired
Base64 encoded content of the auth.json
example:
type:
token
string
Base64 encoded content of token
example:
display_name
stringrequired
Hybrid Deployment Agent display name.
example:
group_id
stringrequired
The unique identifier for the group within your Fivetran account.
example:
registered_at
stringrequired
Time when this Hybrid Deployment Agent was created.
format:
example:
{
"code": "Success",
"message": "Operation performed.",
"data": {
"id": "agent_id",
"files": {
"config_json": "Base64 {... config.json contents ...}",
"docker_compose_yaml": "Base64 {... docker-compose.yaml contents ...}",
"auth_json": "Base64 {... auth.json contents ...}"
},
"token": "token_value",
"display_name": "display_name",
"group_id": "group_id",
"registered_at": "2024-12-01T15:43:29.013729Z"
}
}