EQTY LabDocs

Get API key details

Get details of one of the authenticated user's API keys. JWT/session only — API keys cannot manage API keys

gethttps://localhost:8080/api/v1/api-keys/{keyId}
bash
curl --request GET \
  --url 'https://localhost:8080/api/v1/api-keys/{keyId}' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:8080/api/v1/api-keys/{keyId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface APIKey {
  allowedIps?: string[];
  createdAt?: string;
  createdBy?: string;
  description?: string;
  expiresAt?: string;
  id?: string;
  keyId?: string;
  lastUsedAt?: string;
  name?: string;
  organizationId?: number;
  projectId?: number;
  revocationReason?: string;
  revokedAt?: string;
  revokedBy?: string;
  scopes?: string[];
  status?: "active" | "expired" | "revoked";
  usageCount?: number;
  userId?: string;
}

const response = await fetch("https://localhost:8080/api/v1/api-keys/{keyId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: APIKey = await response.json();
python
import requests

response = requests.get(
    "https://localhost:8080/api/v1/api-keys/{keyId}",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:8080/api/v1/api-keys/{keyId}", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:8080/api/v1/api-keys/{keyId}"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:8080/api/v1/api-keys/{keyId}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:8080/api/v1/api-keys/{keyId}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:8080/api/v1/api-keys/{keyId}")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://localhost:8080/api/v1/api-keys/{keyId}")
        .header("Authorization", "Bearer <token>")
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token

Parameters

Path parameters

NameTypeDescription
keyId
required
string

API Key ID

Responses

200API key details

application/json
  • allowedIpsstring[]
  • createdAtstring<date-time>read-only
  • createdBystringread-only
  • descriptionstring
  • expiresAtstring<date-time>
  • idstringread-only
  • keyIdstringread-only
  • lastUsedAtstring<date-time>read-only
  • namestring
  • organizationIdinteger
  • projectIdinteger
  • revocationReasonstringread-only

    Set via the revoke endpoint

  • revokedAtstring<date-time>read-only
  • revokedBystringread-only
  • scopesstring[]
  • statusstring (enum)read-only

    One ofactiveexpiredrevoked

  • usageCountintegerread-only
  • userIdstringread-only

    Resolved from the caller

Examplejson
{
  "allowedIps": [
    "string"
  ],
  "createdAt": "2025-01-01T00:00:00Z",
  "createdBy": "string",
  "description": "string",
  "expiresAt": "2025-01-01T00:00:00Z",
  "id": "string",
  "keyId": "string",
  "lastUsedAt": "2025-01-01T00:00:00Z",
  "name": "string",
  "organizationId": 0,
  "projectId": 0,
  "revocationReason": "string",
  "revokedAt": "2025-01-01T00:00:00Z",
  "revokedBy": "string",
  "scopes": [
    "string"
  ],
  "status": "active",
  "usageCount": 0,
  "userId": "string"
}

400Bad request - Key ID required

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401Unauthorized - Authentication required

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403Forbidden - API keys cannot manage API keys, or can only view own API keys

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404API key not found

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500Internal server error

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}