Regenerate authentication keys

Regenerate authentication for a Hybrid Deployment Agent.

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

Request

auth_type

string

enum:

"AUTO""MANUAL"

Http + 1.1

PATCH

https://api.fivetran.com/v1/hybrid-deployment-agents/agentId/re-auth

PATCH /v1/hybrid-deployment-agents/agentId/re-auth HTTP/1.1
Accept: application/json
Authorization: Basic <Replace with base64-encoded key>
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 25

{
  "auth_type": "AUTO"
}

Responses

200

Successful response

404

Hybrid Deployment Agent not found in group.

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

files

object

config_json

stringrequired

Base64 encoded content of the config.json

format:

byte

example:

Base64 {... config.json contents ...}

docker_compose_yaml

stringrequired

Base64 encoded content of the docker-compose.yaml

format:

byte

example:

Base64 {... docker-compose.yaml contents ...}

auth_json

stringrequired

Base64 encoded content of the auth.json

format:

byte

example:

Base64 {... auth.json contents ...}

token

string

Base64 encoded content of token

example:

token_value

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,
    "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",
    "deployment_type": "DOCKER",
    "created_by": "created_by",
    "last_used_at": "2024-12-01T15:43:29.013729Z",
    "updated_at": "2024-12-01T15:43:29.013729Z"
  }
}