CreateApiKeyResp

  • Returned by POST /api-keys — the full key summary plus the raw apiKey secret. The secret is shown ONCE at creation time and can never be retrieved later; store it immediately in your secret management system. To replace a lost secret, revoke the key and create a new one.

    • apiKey
      Type: string
      required

      The full secret API key in the form sk_ns_<mode>_<keyId>_<secret>. Returned only once at creation time and cannot be retrieved later — store it immediately in your secret management system.

    • 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".