Regenerate authentication keys
Regenerate authentication for a Hybrid Deployment Agent.
Request schema
Path parameters
agentId
stringrequired
Hybrid Deployment Agent Id
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Request
auth_type
string
enum:
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_BASIC_AUTH
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:
message
string
Response status text
example:
data
objectrequired
id
stringrequired
The unique ID of a Hybrid Deployment Agent.
example:
files
object
config_json
stringrequired
Base64 encoded content of the config.json
format:
example:
docker_compose_yaml
stringrequired
Base64 encoded content of the docker-compose.yaml
format:
example:
auth_json
stringrequired
Base64 encoded content of the auth.json
format:
example:
token
string
Base64 encoded content of token
example:
display_name
stringrequired
Hybrid Deployment Agent display name.
example:
group_id
stringrequired
The unique identifier for the group within your Fivetran account.
example:
registered_at
stringrequired
Time when this Hybrid Deployment Agent was created.
format:
example:
{
"code": "Success",
"message": "Operation performed.",
"data": {
"id": "agent_id",
"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"
}
}