Rule.io SDK

---

Rule.io SDK / client/src / ApiKey

Interface: ApiKey

Defined in: client/src/resources/api-keys/api-keys.types.ts:15

An API key as returned by the Rule.io API.

The key field is only present immediately after creation — it is not returned by list or update operations. Store it securely at creation time.

Properties

createdAt

createdAt: string

Defined in: client/src/resources/api-keys/api-keys.types.ts:20

---

id

id: number

Defined in: client/src/resources/api-keys/api-keys.types.ts:16

---

key?

optional key?: string

Defined in: client/src/resources/api-keys/api-keys.types.ts:19

The raw key value. Only present in the ApiKeysClient.create response.

---

name

name: string | null

Defined in: client/src/resources/api-keys/api-keys.types.ts:17

---

updatedAt

updatedAt: string

Defined in: client/src/resources/api-keys/api-keys.types.ts:21