Hybrid Deployment Agent Management
Our REST API supports the following Hybrid Deployment Agent management actions:
- Create a Hybrid Deployment Agent
- List Hybrid Deployment Agents
- Retrieve Hybrid Deployment Agent Details
- Delete a Hybrid Deployment Agent
- Regenerate authentication keys for a Hybrid Deployment Agent
- Reset Hybrid Deployment Agent credentials
Create a Hybrid Deployment Agent
Creates a new agent within your Fivetran account.
Request
POST https://api.fivetran.com/v1/hybrid-deployment-agents
{
"group_id": "string",
"display_name": "string",
"env_type": "DOCKER",
"accept_terms": true,
"auth_type": "MANUAL"
}
Payload parameters
Name | Description | Possible Values |
---|---|---|
group_id (required) | The unique identifier for the group or group within the Fivetran system. | |
display_name (required) | The unique name for the agent. | |
env_type (required) | The environment type; the data processing location. | The only supported type is DOCKER |
accept_terms (required) | The boolean specifying whether the caller accepts the Fivetran On-Prem Software License Addendum. | true or false |
auth_type (optional) | The agent auth type. Defines how agent should be authorised. | MANUAL , AUTO |
Response with MANUAL
agent auth type
HTTP 201 Created
{
"code": "Success",
"message": "Success",
"data": {
"id": "string",
"display_name": "string",
"group_id": "string",
"registered_at": "1970-01-01T00:00:00.000000Z",
"files": {
"config_json": "string",
"auth_json": "string",
"docker_compose_yaml": "string"
}
}
}
Name | Description |
---|---|
id | The unique identifier for the agent within the Fivetran system. |
display_name | The unique name for the agent. |
group_id | The group ID. |
registered_at | The timestamp of the time the agent was created in your account. |
files.config_json | The base64-encoded content of the config.json file. |
files.auth_json | The base64-encoded content of the auth.json file. |
files.docker_compose_yaml | The base64-encoded content of the compose file for the chosen containerization type. |
Response with AUTO
agent auth type
HTTP 201 Created
{
"code": "Success",
"message": "Success",
"data": {
"id": "string",
"display_name": "string",
"group_id": "string",
"registered_at": "1970-01-01T00:00:00.000000Z",
"token": "master_token_value"
}
}
Name | Description |
---|---|
id | The unique identifier for the agent within the Fivetran system. |
display_name | The unique name for the agent. |
group_id | The group ID. |
registered_at | The timestamp of the time the agent was created in your account. |
token | The master token value. |
Error responses
HTTP 400 BAD REQUEST
The name is missing or the license not accepted in the payload.
HTTP 404 NOT_FOUND
The specified group is not found.
HTTP 409 CONFLICT
An agent with same name already exists.
List Hybrid Deployment Agents
Returns a list of agents with usage within your Fivetran account.
Request
GET https://api.fivetran.com/v1/hybrid-deployment-agents
Query parameters
Name | Description |
---|---|
groupId | The optional filter. When used, the response will only contain information for the agents with the specified group. |
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",
"display_name": "string",
"group_id": "string",
"registered_at": "1970-01-01T00:00:00.000000Z",
"usage": [
{
"connection_id": "string",
"schema": "string",
"service": "string"
}
]
}
],
"next_cursor": "eyJza2lwIjoyfQ"
}
}
Fields
Name | Description |
---|---|
items | The collection of agents with usage. |
next_cursor | The value of the cursor parameter for the next page. |
Retrieve Hybrid Deployment Agent details
Retrieves the details of the specified agent.
Request
GET https://api.fivetran.com/v1/hybrid-deployment-agents/{agent_id}
Path parameters
Name | Description |
---|---|
agent_id (required) | The unique identifier for the agent within your Fivetran account. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "string",
"display_name": "string",
"group_id": "string",
"registered_at": "1970-01-01T00:00:00.000000Z",
"usage": [
{
"connection_id": "string",
"schema": "string",
"service": "string"
}
]
}
}
Name | Description |
---|---|
id | The unique identifier for the agent within the Fivetran system. |
display_name | The unique name for the agent. |
registred_at | The timestamp of the time the agent was created in your account. |
usage .connectionId | The unique identifier of the connection associated with the agent. |
usage .schema | The connection schema name. |
usage .service | The connection type. |
HTTP 404 NOT_FOUND
An agent with the specified ID is not found.
Delete a Hybrid Deployment Agent
Deletes the specified agent from your Fivetran account.
Request
DELETE https://api.fivetran.com/v1/hybrid-deployment-agents/{agent_id}
Path parameters
Name | Description |
---|---|
agent_id (required) | The unique identifier for the agent within your Fivetran account. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Hybrid deployment agent with id = agent_id has been deleted."
}
HTTP 404 NOT_FOUND
An agent with the specified ID is not found.
HTTP 409 CONFLICT
An agent with the specified ID has associated connections.
Regenerate keys
Regenerates authentication keys for the specified agent.
Request
PATCH https://api.fivetran.com/v1/hybrid-deployment-agents/{agent_id}/re-auth
Path parameters
Name | Description |
---|---|
agent_id (required) | The unique identifier for the agent within your Fivetran account. |
Payload parameters
Payload for this endpoint is optional. The request without payload will be processed with the default behavior available for your account.
Name | Description | Possible Values |
---|---|---|
auth_type (optional) | The agent auth type. Defines how agent should be authorized. | MANUAL , AUTO |
Response for MANUAL
agent auth type
HTTP 200 Success
{
"code": "Success",
"message": "Success",
"data": {
"id": "string",
"display_name": "string",
"group_id": "string",
"registered_at": "1970-01-01T00:00:00.000000Z",
"files": {
"config_json": "string",
"auth_json": "string",
"docker_compose_yaml": "string"
}
}
}
Name | Description |
---|---|
id | The unique identifier for the agent within the Fivetran system. |
display_name | The unique name for the agent. |
group_id | The group ID. |
registered_at | The timestamp of the time the agent was created in your account. |
files.config_json | Base64-encoded content of the config.json file. |
files.auth_json | Base64-encoded content of the auth.json file. |
files.docker_compose_yaml | Base64-encoded content of the compose file for the chosen containerization type. |
Response for AUTO
agent auth type
HTTP 200 Success
{
"code": "Success",
"message": "Success",
"data": {
"id": "string",
"display_name": "string",
"group_id": "string",
"registered_at": "1970-01-01T00:00:00.000000Z",
"token": "master_token_value"
}
}
Name | Description |
---|---|
id | The unique identifier for the agent within the Fivetran system. |
display_name | The unique name for the agent. |
group_id | The group ID. |
registered_at | The timestamp of the time the agent was created in your account. |
token | The master token value. |
Reset credentials
Resets authentication credentials for the specified agent.
Request
POST https://api.fivetran.com/v1/hybrid-deployment-agents/{agent_id}/reset-credentials
Path parameters
Name | Description |
---|---|
agent_id (required) | The unique identifier for the agent within your Fivetran account. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "Successfully reset credentials for the agent with id = agent_id"
}
HTTP 404 NOT_FOUND
An agent with the specified ID is not found.