Get Api Key

Get API key by ID.

GET /api/v1/api-keys/{api_key_id}

Get Api Key

cURL

curl --request GET \
  --url https://api.example.com/api/v1/api-keys/{api_key_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/v1/api-keys/{api_key_id}"

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

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

print(response.text)

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

fetch('https://api.example.com/api/v1/api-keys/{api_key_id}', 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.example.com/api/v1/api-keys/{api_key_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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.example.com/api/v1/api-keys/{api_key_id}"

	req, _ := http.NewRequest("GET", 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.get("https://api.example.com/api/v1/api-keys/{api_key_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/api-keys/{api_key_id}")

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

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

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

200

{
  "key": "<string>",
  "label": "<string>",
  "workspace_id": "<string>",
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "hashed_secret": "<string>",
  "status": "active",
  "last_used_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "permissions": [
    "<string>"
  ],
  "ip_whitelist": [
    "<string>"
  ],
  "collections": [
    "<string>"
  ],
  "created_by": "<string>",
  "secret": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id · string | null

The workspace ID

Path Parameters

api_key_id · string · required

Response

200

application/json

Successful Response

Schema for reading API key data.

key · string · required

API key identifier

Required string length: 1 - 50

label · string · required

API key label/name

Required string length: 1 - 255

workspace_id · string · required

Reference to workspace

id · string

created_at · string | null

updated_at · string | null

hashed_secret · string | null

Hashed API key secret

status · string · default: active

API key status

last_used_at · string<date-time> | null

When the API key was last used

expires_at · string<date-time> | null

API key expiration date

permissions · string[] | null

List of permissions granted to this API key

ip_whitelist · string[] | null

List of allowed IP addresses

collections · string[] | null

List of collection IDs this API key can access

created_by · string | null

User who created the API key

secret · string | null

API key secret