Create Service Account API Key Private Preview

Creates a new API key for the specified service account. The secret is returned once at creation and cannot be retrieved again.

Note: Only a regular user can perform this operation.

Request schema

Path parameters

userId

stringrequired

The unique identifier for the user within the account.

example:

userId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

expiration_period_days

integer

The number of days until the API key expires. Defaults to 90. Maximum is 365.

format:

int32

example:

Http + 1.1

POST

https://api.fivetran.com/v1/users/userId/api-keys

POST /v1/users/userId/api-keys HTTP/1.1
Accept: application/json
Authorization: Basic 
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 34

{
  "expiration_period_days": 90
}

Responses

201

Successful response

400

Bad request

404

User not found

`201`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

API key has been created

data

objectrequired

key_value

stringrequired

The public identifier of the API key.

example:

key_abc123

key_secret

stringrequired

The secret portion of the API key. Only returned at creation time and cannot be retrieved again.

example:

secret_xyz789

key_status

stringrequired

The status of the API key. Possible values: ACTIVE: The key has a single active secret, ACTIVE_GRACE: The key has two active secrets during rotation overlap, and EXPIRED: The key has expired.

example:

ACTIVE

created_at

stringrequired

The timestamp that the user created their API key

format:

date-time

example:

2024-01-01T00:00:00Z

expires_at

string

The timestamp when the API key expires.

format:

date-time

example:

2024-04-01T00:00:00Z

{
  "code": "Success",
  "message": "API key has been created",
  "data": {
    "key_value": "key_abc123",
    "key_secret": "secret_xyz789",
    "key_status": "ACTIVE",
    "created_at": "2024-01-01T00:00:00Z",
    "expires_at": "2024-04-01T00:00:00Z"
  }
}