System Key

Represents a system API key in your Fivetran account. System keys are scoped credentials with fine-grained permissions that control access to specific resource types and actions. Unlike user API keys, system keys are not tied to a specific user and can be configured with precise access levels for each resource type.

Resource attributes

The following attributes describe a system key and its permissions.

System key attributes

Field name	Type	Description
`id`	string, read-only	Unique identifier of the system key.
`name`	string	Name of the system key.
`key`	string, read-only	Key value used for authentication.
`secret`	string, read-only	Secret value of the system key. Returned only when the key is rotated.
`permissions`	array of objects, read-only	List of permissions assigned to the system key. See Permission attributes.
`created_at`	string, read-only	Date and time the system key was created, in ISO 8601 format.
`expired_at`	string, read-only	Date and time the system key expires, in ISO 8601 format.
`last_used_at`	string, read-only	Date and time the system key was last used, in ISO 8601 format.
`updated_at`	string, read-only	Date and time the system key was last updated, in ISO 8601 format.

Permission attributes

These attributes describe an individual entry in the permissions array.

Field name	Type	Description
`resource_type`	string	The resource type the permission applies to. Possible values: `ACCOUNT`, `USER`, `WEBHOOK`, `TEAM`, `ROLES`, `DESTINATION`, `TRANSFORMATION`, `REMOTE_EXECUTION_AGENT`, `CONNECTOR`.
`access_level`	string	The level of access granted for the resource type. Possible values: `MANAGE` – Full read and write access. `READ` – Read-only access. `NONE` – No access.
`resource_filter.ids`	array of strings	Limits the permission to specific resource IDs. Omit to apply to all resources of the type.
`resource_filter.group_ids`	array of strings	Limits the permission to resources in specific groups. Omit to apply to all groups.

Supported operations

Category	Endpoint	Description
List	`GET /v1/system-keys`	Returns a paginated list of all system keys in the account.
Create	`POST /v1/system-keys`	Creates a new system key.
Retrieve	`GET /v1/system-keys/{keyId}`	Returns the details of a system key.
Update	`PATCH /v1/system-keys/{keyId}`	Updates the name or permissions of an existing system key.
Delete	`DELETE /v1/system-keys/{keyId}`	Deletes a system key.
Rotate	`POST /v1/system-keys/{keyId}/rotate`	Rotates the secret value of a system key and updates its expiration date.