BuilderKeyCreated

  • Safe fields of a self-serve API key — never includes the plaintext key or hash.

    • createdAt
      Type: string Format: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • dailyLimit
      Type: integer | null
      required

      Free-tier daily cap; null for a Builder key (uncapped daily).

    • id
      Type: integer
      required

      Integer numbers.

    • keyPrefix
      Type: string
      required

      First chars of the key, for display. Not usable for auth.

    • label
      Type: string
      required
    • lastUsedAt
      Type: string | null Format: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • plaintext
      Type: string
      required

      The full hg_live_… key — shown once, never retrievable again.

    • rateLimitPerMinute
      Type: integer | null
      required

      Builder tier's per-minute limit; null on the free tier (daily-capped instead).

    • requestCount
      Type: integer
      required

      Integer numbers.

    • revokedAt
      Type: string | null Format: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • webhookUrl
      Type: string | null Format: uri
      required