Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0492100246.4 KB
teams

Create new team API Key.

post/teams/{team_name}/apikeys

Path parameters

team_namestring required

The unique name for the team.

Example:cloudquery

Request body

namestring required

Name of the API key

expires_atstring date-time required
scope'read-and-write' | 'syncs-operations-only'

Scope of permissions for the API key. API keys are used for creating new plugin versions and downloading existing plugins

Example request

{
  "name": "cli-api-key"
}

Response

Response

namestring required

Name of the API key

created_bystring

email of the user that created the API key

idstring uuid required

ID of the API key

keystring

API key. Will be shown only in the response when creating the key.

created_atstring date-time
expires_atstring date-time required

Timestamp at which API key will stop working

last_access_atstring date-time

Timestamp at which API key was last used - accurate to the day only.

expiredboolean required

Whether the API key has expired or not

scope'read-and-write' | 'syncs-operations-only' required

Scope of permissions for the API key. API keys are used for creating new plugin versions and downloading existing plugins

Example response

{
  "name": "cli-api-key",
  "created_by": "user@example.com",
  "id": "12345678-1234-1234-1234-1234567890ab",
  "key": "1234567890abcdef1234567890abcdef",
  "created_at": "2017-07-14T16:53:42Z",
  "expires_at": "2017-07-14T16:53:42Z",
  "last_access_at": "2017-07-14T16:53:42Z"
}