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: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "scope": "ADMIN"
}
'
import requests

url = "https://api.qovery.com/organization/{organizationId}/apiToken"

payload = {
"name": "<string>",
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"scope": "ADMIN"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
scope: 'ADMIN'
})
};

fetch('https://api.qovery.com/organization/{organizationId}/apiToken', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qovery.com/organization/{organizationId}/apiToken",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'scope' => 'ADMIN'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.qovery.com/organization/{organizationId}/apiToken"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"scope\": \"ADMIN\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.qovery.com/organization/{organizationId}/apiToken")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"scope\": \"ADMIN\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/organization/{organizationId}/apiToken")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"scope\": \"ADMIN\"\n}"

response = http.request(request)
puts response.read_body
{
  "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

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $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
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
read-only
name
string
description
string
token
string

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

role_name
string
role_id
string<uuid>