Regenerate API token

Rotate the secret of one of the authenticated user’s API tokens. The old key stops working and the new key is returned only once. Always allowed, regardless of plan.

POST /auth/apiTokens/{apiTokenId}/regenerate

Regenerate API token

cURL

curl --request POST \
  --url https://api.galtea.ai/auth/apiTokens/{apiTokenId}/regenerate \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.galtea.ai/auth/apiTokens/{apiTokenId}/regenerate"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.galtea.ai/auth/apiTokens/{apiTokenId}/regenerate', 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.galtea.ai/auth/apiTokens/{apiTokenId}/regenerate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.galtea.ai/auth/apiTokens/{apiTokenId}/regenerate"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.galtea.ai/auth/apiTokens/{apiTokenId}/regenerate")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/auth/apiTokens/{apiTokenId}/regenerate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "id": "apiToken_abc123",
  "name": "ci-pipeline",
  "keyId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "keyPreview": "gsk_3d4d7d38-a5ec-4d9f-94a6-5a3f61db9d7d",
  "apiKey": "gsk_abc123def456"
}

{
  "error": "Error type",
  "message": "Error message description"
}

{
  "error": "Error type",
  "message": "Error message description"
}

{
  "error": "Error type",
  "message": "Error message description"
}

Authorizations

Authorization · string · header · required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

apiTokenId · string · required

Response

200

application/json

API token regenerated successfully

id · string · required

Example:

"apiToken_abc123"

name · string · required

Example:

"ci-pipeline"

keyId · string · required

Public identifier of the key (the uuid in gsk__)

createdAt · string<date-time> · required

keyPreview · string · required

Display-only public head of the key (gsk_<keyId>). Contains no secret.

Example:

"gsk_3d4d7d38-a5ec-4d9f-94a6-5a3f61db9d7d"

apiKey · string · required

The generated API key in gsk_* format. Returned only once — store it securely.

Pattern: ^gsk[_-].+

Example:

"gsk_abc123def456"