Retrieve API Key - Byteport

GET

tokens

{id}

curl https://api.byteport.com/v1/tokens/9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34 \
  -H "Authorization: Bearer $BYTEPORT_API_KEY" \
  -H "User-Agent: my-app/1.0"

const id = "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34";
const res = await fetch(`https://api.byteport.com/v1/tokens/${id}`, {
  headers: {
    Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
    "User-Agent": "my-app/1.0",
  },
});
const key = await res.json();

import os, requests

key_id = "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34"
key = requests.get(
    f"https://api.byteport.com/v1/tokens/{key_id}",
    headers={
        "Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
        "User-Agent": "my-app/1.0",
    },
).json()

{
  "id":         "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34",
  "name":       "production-pipeline",
  "created_at": "2026-05-14T17:02:11Z",
  "expires_at": "2026-12-31T23:59:59Z"
}

{
  "error": 404,
  "message": "not found"
}

Retrieve metadata for a single API key by its id. Like List, this never returns the raw token secret — only the fields you can safely display. A key that doesn’t belong to your workspace returns 404.

curl https://api.byteport.com/v1/tokens/9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34 \
  -H "Authorization: Bearer $BYTEPORT_API_KEY" \
  -H "User-Agent: my-app/1.0"

const id = "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34";
const res = await fetch(`https://api.byteport.com/v1/tokens/${id}`, {
  headers: {
    Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
    "User-Agent": "my-app/1.0",
  },
});
const key = await res.json();

import os, requests

key_id = "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34"
key = requests.get(
    f"https://api.byteport.com/v1/tokens/{key_id}",
    headers={
        "Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
        "User-Agent": "my-app/1.0",
    },
).json()

{
  "id":         "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34",
  "name":       "production-pipeline",
  "created_at": "2026-05-14T17:02:11Z",
  "expires_at": "2026-12-31T23:59:59Z"
}

{
  "error": 404,
  "message": "not found"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Identifier of the API key — the id returned by Create or List (a UUID).

Response

The requested API key.

An API key as exposed to callers. Never includes the raw token secret or its hash.

string

Unique identifier for the key (a UUID). Use it as the {id} path segment for Retrieve, Update, and Delete.

Example:

"9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34"

name

string

The human-readable label set at creation or via Update.

Example:

"production-pipeline"

created_at

string<date-time>

When the key was created (RFC 3339, UTC).

Example:

"2026-05-14T17:02:11Z"

expires_at

string<date-time>

When the key expires. Omitted entirely if the key never expires.

Example:

"2026-12-31T23:59:59Z"

revoked_at

string<date-time>

When the key was revoked. Omitted entirely while the key is active.

Example:

"2026-04-20T12:00:00Z"

List API Keys

Update API Key

curl https://api.byteport.com/v1/tokens/9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34 \
  -H "Authorization: Bearer $BYTEPORT_API_KEY" \
  -H "User-Agent: my-app/1.0"

const id = "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34";
const res = await fetch(`https://api.byteport.com/v1/tokens/${id}`, {
  headers: {
    Authorization: `Bearer ${process.env.BYTEPORT_API_KEY}`,
    "User-Agent": "my-app/1.0",
  },
});
const key = await res.json();

import os, requests

key_id = "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34"
key = requests.get(
    f"https://api.byteport.com/v1/tokens/{key_id}",
    headers={
        "Authorization": f"Bearer {os.environ['BYTEPORT_API_KEY']}",
        "User-Agent": "my-app/1.0",
    },
).json()

{
  "id":         "9b7e2c1a-4f3d-4a2b-8c1e-2d6f5a0b7c34",
  "name":       "production-pipeline",
  "created_at": "2026-05-14T17:02:11Z",
  "expires_at": "2026-12-31T23:59:59Z"
}

{
  "error": 404,
  "message": "not found"
}