Returns Hybrid Deployment Agent Details
Returns Hybrid Deployment Agent Details.
Request schema
Path parameters
agentId
stringrequired
Hybrid Deployment Agent Id
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Http + 1.1
GET
https://api.fivetran.com/v1/hybrid-deployment-agents/agentId
GET /v1/hybrid-deployment-agents/agentId HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com
Responses
200
Successful response
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:
usage
array
schema
stringrequired
The name used both as the connection's name within the Fivetran system and as the source schema's name within your group.
example:
service
stringrequired
The connector type name within the Fivetran system.
example:
connection_id
stringrequired
The unique identifier for the connection within the Fivetran
example:
registered_at
stringrequired
Time when this Hybrid Deployment Agent was created.
format:
example:
display_name
stringrequired
Hybrid Deployment Agent display name.
example:
group_id
stringrequired
The unique identifier for the group within your Fivetran account.
example:
{
"code": "Success",
"message": "Operation performed.",
"data": {
"id": "agent_id",
"usage": [
{
"schema": "schema_name",
"service": "service",
"connection_id": "connection_id"
}
],
"registered_at": "2024-12-01T15:43:29.013729Z",
"display_name": "display_name",
"group_id": "group_id"
}
}