Skip to main content
POST
/
organization
/
{organizationId}
/
apiToken
Create an organization api token
curl --request POST \
  --url https://api.qovery.com/organization/{organizationId}/apiToken \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "scope": "ADMIN",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "token": "<string>",
  "role_name": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

​
organizationId
string<uuid>
required

Organization ID

Body

application/json
​
name
string
required
​
role_id
string<uuid> | null
required

the roleId provided by the "List organization custom roles" endpoint.

​
description
string
​
scope
enum<string> | null

deprecated

Available options:
ADMIN

Response

Organization api token created

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
​
name
string
​
description
string
​
token
string

the generated token to send in 'Authorization' header prefixed by 'Token '

​
role_name
string
​
role_id
string<uuid>