Rotate a System Key
Updates the secret value and expired_at date for an existing system key within your Fivetran account.
Request schema
Path parameters
keyId
stringrequired
The unique identifier for the system key within your Fivetran account.
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
example:
default:
Request
expiration_period
string
The system key's expiration period
example:
enum:
Http + 1.1
POST
https://api.fivetran.com/v1/system-keys/key_id/rotate
POST /v1/system-keys/key_id/rotate HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 116
{
"value": {
"name": "updated_key",
"permissions": {
"expiration_period": "THREE_MONTHS"
}
}
}
Responses
200
Successful response
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
id
string
The unique identifier for the system key within the Fivetran system
example:
name
string
The system key name within the account
example:
key
string
The key value of the system key
example:
secret
string
The secret value of rotated system key
example:
permissions
array
resource_filter
object
ids
array
The IDs of managed entities
type:
group_ids
array
The IDs of managed groups
type:
access_level
string
The access level for the permission
example:
enum:
resource_type
string
The resource type for the permission
example:
enum:
created_at
string
The system key creation timestamp
format:
example:
expired_at
string
The system key expiration timestamp
format:
example:
last_used_at
string
The timestamp of last usage
format:
example:
updated_at
string
The system key update timestamp
format:
example:
rotate_response
{
"code": "Success",
"message": "System key with id 'rushed_fainting' has been rotated",
"data": {
"id": "rushed_fainting",
"name": "prod_key",
"key": "<key_value>",
"secret": "<secret_value>",
"created_at": "2023-11-10T19:32:58.646Z",
"expired_at": "2024-02-10T19:32:58.646Z",
"permissions": [
{
"resource_type": "USER",
"access_level": "READ"
},
{
"resource_type": "WEBHOOK",
"access_level": "MANAGE"
},
{
"resource_type": "DESTINATION",
"access_level": "MANAGE"
},
{
"resource_type": "TRANSFORMATION",
"access_level": "MANAGE",
"resource_filter": {
"group_ids": [
"group_id_1",
"group_id_2"
]
}
},
{
"resource_type": "CONNECTOR",
"access_level": "NONE",
"resource_filter": {
"ids": [
"connector_id_3",
"connector_id_4"
]
}
},
{
"resource_type": "CONNECTOR",
"access_level": "MANAGE"
}
]
}
}