Retrieve System Key details
Retrieves a system key object 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:
Http + 1.1
GET
https://api.fivetran.com/v1/system-keys/key_id
GET /v1/system-keys/key_id HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com
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:
get_response
{
"code": "Success",
"data": {
"id": "rushed_fainting",
"name": "updated_key",
"key_value": "<key_value>",
"created_at": "2023-10-17T14:01:16.318Z",
"updated_at": "2023-10-17T14:02:20.919291Z",
"expired_at": "2024-01-17T14:01:16.318Z",
"permissions": [
{
"resource_type": "CONNECTOR",
"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"
]
}
}
]
}
}