Returns Hybrid Deployment Agent Details

Returns Hybrid Deployment Agent Details.

Request schema

Path parameters

agentId

stringrequired

Hybrid Deployment Agent Id

example:

agentId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

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 with base64-encoded key>
Host: api.fivetran.com

Responses

200

Successful response

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique ID of a Hybrid Deployment Agent.

example:

agent_id

version

stringrequired

Version of the Hybrid Deployment Agent

example:

version

enabled

booleanrequired

The boolean value specifying whether the Hybrid Deployment Agent is enabled.

example:

true

online

booleanrequired

The boolean value specifying whether the Hybrid Deployment Agent is online.

example:

true

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:

schema_name

service

stringrequired

The connector type name within the Fivetran system.

example:

service

connection_id

stringrequired

The unique identifier for the connection within the Fivetran

example:

connection_id

display_name

stringrequired

Hybrid Deployment Agent display name.

example:

display_name

group_id

stringrequired

The unique identifier for the group within your Fivetran account.

example:

group_id

registered_at

stringrequired

Time when this Hybrid Deployment Agent was created.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

deployment_type

stringrequired

Environment type.

enum:

"DOCKER""PODMAN""KUBERNETES""SNOWPARK"

created_by

stringrequired

The actor who created the Hybrid Deployment Agent

example:

created_by

last_used_at

stringrequired

The time this Hybrid Deployment Agent was last used.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

updated_at

stringrequired

Time when this Hybrid Deployment Agent was updated.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "id": "agent_id",
    "version": "version",
    "enabled": true,
    "online": true,
    "usage": [
      {
        "schema": "schema_name",
        "service": "service",
        "connection_id": "connection_id"
      }
    ],
    "display_name": "display_name",
    "group_id": "group_id",
    "registered_at": "2024-12-01T15:43:29.013729Z",
    "deployment_type": "DOCKER",
    "created_by": "created_by",
    "last_used_at": "2024-12-01T15:43:29.013729Z",
    "updated_at": "2024-12-01T15:43:29.013729Z"
  }
}