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
default:
example:
Request
expiration_period
string
The system key's expiration period
enum:
Http + 1.1
POST
https://api.fivetran.com/v1/system-keys/keyId/rotate
POST /v1/system-keys/keyId/rotate HTTP/1.1 Accept: application/json Authorization: BasicContent-Type: application/json Host: api.fivetran.com Content-Length: 39 { "expiration_period": "SIX_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
enum:
resource_type
string
The resource type for the permission
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:
{ "code": "Success", "message": "Operation performed.", "data": { "id": "key_id", "name": "MySystemKey", "key": "ft_rDefAFDSgFdAGdFG", "secret": "uytFfdSfDADFgfCgFBVsdCSFg4fsGfFg87fhRuuFASuTHkETSfg", "permissions": [ { "resource_filter": { "ids": {}, "group_ids": {} }, "access_level": "MANAGE", "resource_type": "DESTINATION" } ], "created_at": "2023-08-20T10:15:20.677566Z", "expired_at": "2024-08-20T10:15:20.677566Z", "last_used_at": "2023-08-20T10:15:20.677566Z", "updated_at": "2023-08-20T10:15:20.677566Z" } }