POST /v1/hybrid-deployment-agents
Creates a new Hybrid Deployment Agent in a group.
Servers
- https://api.fivetran.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | No |
Default value: "application/json" |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
env_type |
String | Yes |
Environment type. Possible values:
|
auth_type |
String | No |
Agent Auth Mode. Defines how agent should be authorised. Possible values:
|
accept_terms |
Boolean | Yes |
Boolean, must be true to indicate that the caller accepts the Fivetran On-Prem Software License Addendum. |
display_name |
String | Yes |
Hybrid Deployment Agent display name. |
group_id |
String | No |
The unique identifier for the group within your Fivetran account. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.