Create a new System Key

Creates a new system key with your Fivetran account.

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

name

string

The system key name within the account

example:

MySystemKey

expiration_period

string

The system key's expiration period

enum:

"ONE_WEEK""ONE_MONTH""THREE_MONTHS""SIX_MONTHS""INFINITE"

permissions

array

resource_type

string

The resource type for the permission

enum:

"ACCOUNT""USER""WEBHOOK""TEAM""ROLES""DESTINATION""TRANSFORMATION""REMOTE_EXECUTION_AGENT""CONNECTOR"

access_level

string

The access level for the permission

enum:

"NONE""READ""MANAGE"

resource_filter

object

ids

array

The IDs of managed entities

type:

string

group_ids

array

The IDs of managed groups

type:

string

Http + 1.1

POST

https://api.fivetran.com/v1/system-keys

POST /v1/system-keys HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 246

{
  "name": "MySystemKey",
  "expiration_period": "SIX_MONTHS",
  "permissions": [
    {
      "resource_type": "CONNECTOR",
      "access_level": "MANAGE",
      "resource_filter": {
        "ids": {},
        "group_ids": {}
      }
    }
  ]
}

Responses

201

Successful response

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

string

The unique identifier for the system key within the Fivetran system

example:

key_id

name

string

The system key name within the account

example:

MySystemKey

key

string

The key value of the system key

example:

ft_rDefAFDSgFdAGdFG

secret

string

The secret value of rotated system key

example:

uytFfdSfDADFgfCgFBVsdCSFg4fsGfFg87fhRuuFASuTHkETSfg

permissions

array

resource_filter

object

ids

array

The IDs of managed entities

type:

string

group_ids

array

The IDs of managed groups

type:

string

access_level

string

The access level for the permission

enum:

"NONE""READ""MANAGE"

resource_type

string

The resource type for the permission

enum:

"ACCOUNT""USER""WEBHOOK""TEAM""ROLES""DESTINATION""TRANSFORMATION""REMOTE_EXECUTION_AGENT""CONNECTOR"

created_at

string

The system key creation timestamp

format:

date-time

example:

2023-08-20T10:15:20.677566Z

expired_at

string

The system key expiration timestamp

format:

date-time

example:

2024-08-20T10:15:20.677566Z

last_used_at

string

The timestamp of last usage

format:

date-time

example:

2023-08-20T10:15:20.677566Z

updated_at

string

The system key update timestamp

format:

date-time

example:

2023-08-20T10:15:20.677566Z

{
  "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"
  }
}