Get an API key

GET

/v1/api-keys/{keyId}

KEY_ID=9d4c1a2b-6e8f-4a3c-b5d7-2f1e0a9b8c7d  # a keyId from the list of API keys

curl -sS "https://api.speccapture.com/v1/api-keys/$KEY_ID" \
  -H "Authorization: Bearer $SPECCAPTURE_API_KEY"

using System.Text.Json;

using HttpClient http = new() { BaseAddress = new Uri("https://api.speccapture.com") };
http.DefaultRequestHeaders.Authorization = new("Bearer", Environment.GetEnvironmentVariable("SPECCAPTURE_API_KEY"));

string keyId = args[0]; // a keyId from the list of API keys

HttpResponseMessage response = await Call(HttpMethod.Get, $"/v1/api-keys/{keyId}");
Console.WriteLine(await response.Content.ReadAsStringAsync());

// Sends a request; stops with the problem's code and detail if the API refuses it.
async Task<HttpResponseMessage> Call(HttpMethod method, string path, HttpContent? body = null, string? idempotencyKey = null) {
    using HttpRequestMessage request = new(method, path) { Content = body };
    if (idempotencyKey is not null) request.Headers.Add("Idempotency-Key", idempotencyKey);
    HttpResponseMessage response = await http.SendAsync(request);
    if (!response.IsSuccessStatusCode) {
        JsonElement problem = await Json(response);
        string? detail = (problem.TryGetProperty("detail", out JsonElement text) ? text : problem.GetProperty("title")).GetString();
        Console.Error.WriteLine($"{(int)response.StatusCode} {problem.GetProperty("code")}: {detail}");
        Environment.Exit(1);
    }
    return response;
}

// Reads an answer as JSON.
static async Task<JsonElement> Json(HttpResponseMessage response) =>
    JsonDocument.Parse(await response.Content.ReadAsStringAsync()).RootElement;

import os
import sys

import requests

API = "https://api.speccapture.com"
session = requests.Session()
session.headers["Authorization"] = f"Bearer {os.environ['SPECCAPTURE_API_KEY']}"


def call(method, path, **kwargs):
    """Send a request; stop with the problem's code and detail if the API refuses it."""
    response = session.request(method, API + path, **kwargs)
    if not response.ok:
        problem = response.json()
        sys.exit(f"{response.status_code} {problem['code']}: {problem.get('detail', problem['title'])}")
    return response


key_id = sys.argv[1]  # a keyId from the list of API keys

print(call("GET", f"/v1/api-keys/{key_id}").text)

const API = "https://api.speccapture.com";
const headers = { Authorization: `Bearer ${process.env.SPECCAPTURE_API_KEY}` };

const [keyId] = process.argv.slice(2); // a keyId from the list of API keys

console.log(await call("GET", `/v1/api-keys/${keyId}`).then((response) => response.text()));

// Sends a request; stops with the problem's code and detail if the API refuses it.
async function call(method, path, init = {}) {
  const response = await fetch(API + path, { ...init, method, headers: { ...headers, ...init.headers } });
  if (!response.ok) {
    const problem = await response.json();
    console.error(`${response.status} ${problem.code}: ${problem.detail ?? problem.title}`);
    process.exit(1);
  }
  return response;
}

The key as GET /v1/api-keys lists it: its name, prefix, mode, role, who made it, when it was last used and whether it still works (status, stopsAt). Never the key itself. Another workspace’s key, or an id nobody issued, is 404 not_found. A key acting as the workspace’s owner or an admin.

Authorizations

ApiKey

Parameters

Path Parameters

keyId

required

string format: uuid

Responses

200

application/json

object

keyId

required

string format: uuid

name

required

string

prefix

required

string

mode

required

Allowed values: live test

role

required

Allowed values: owner admin member

requestsPerMinute

required

integer format: int32

createdBy

required

object

kind

required

Allowed values: person apiKey

name

required

null | string

createdAt

required

string format: date-time

lastUsedAt

required

null | string format: date-time

status

required

Allowed values: active stopping revoked

stopsAt

required

null | string format: date-time

403

Forbidden: a problem with a stable code. See Errors for every code and what to do about it.

application/problem+json

Every error: a problem with a stable code. https://speccapture.com/docs/api/errors lists every code.

object

type

A link to the code’s entry in the docs.

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

code

What went wrong, as a stable code to branch on: a published code never changes meaning.

string

traceId

This request’s trace: quote it when asking for help.

string

404

Not Found: a problem with a stable code. See Errors for every code and what to do about it.

application/problem+json

Every error: a problem with a stable code. https://speccapture.com/docs/api/errors lists every code.

object

type

A link to the code’s entry in the docs.

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

code

What went wrong, as a stable code to branch on: a published code never changes meaning.

string

traceId

This request’s trace: quote it when asking for help.

string