ApiKeySummary

A non-secret summary of an API key. The secret material is never returned by any endpoint after creation.

  • createdAt
    Type: stringFormat: date-time
    required

    When the API key was created.

  • keyId
    Type: string
    required

    Public identifier — the <keyId> segment of the full key (sk_ns_<mode>_<keyId>_<secret>). Safe to log. Pass as the keyId path param to POST .../api-keys/{keyId}/revoke.

  • name
    Type: string
    required

    Human-readable label assigned at creation time.

  • status
    Type: stringenum
    required

    Computed status: Revoked if the key was explicitly revoked; Expired if expiresAt is in the past; otherwise Active.

    values
    • Active
    • Expired
    • Revoked
  • expiresAt
    Type: stringFormat: date-time

    When the API key expires. Absent if the key was created with expiration: "never".