Create a Hybrid Deployment Agent
Creates a new Hybrid Deployment Agent in a group.
Request schema
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
Boolean, must be true to indicate that the caller accepts the Fivetran On-Prem Software License Addendum.
Agent Auth Mode. Defines how agent should be authorised.
Hybrid Deployment Agent display name.
Environment type.
The unique identifier for the group within your Fivetran account.
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
Successful response schema
Response status code
Response status text
The unique ID of a Hybrid Deployment Agent.
Base64 encoded content of the config.json
Base64 encoded content of the docker-compose.yaml
Base64 encoded content of the auth.json
Base64 encoded content of token
Hybrid Deployment Agent display name.
The unique identifier for the group within your Fivetran account.
Time when this Hybrid Deployment Agent was created.
{
"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"
}
}