Skip to main content

ApiKey

keyIdstringrequired
labelstringrequired

Possible values: <= 80 characters

prefixstring

crk_live_<keyId>_ plus the first 4 secret characters.

scopesstring[]required

Possible values: [relay, read]

policy objectrequired
receiverAllowListAddress[]

Contracts your users may call at your expense. Required and non-empty for scope relay.

Possible values: <= 100

functionAllowListstring[]

Possible values: <= 100

maxRuPerSenderPerDayinteger<int64>

Relay Units.

Possible values: >= 0

maxRuPerDayinteger<int64>

Relay Units.

Possible values: >= 0

ipAllowListstring[]

Possible values: <= 20

statusstringrequired

Possible values: [active, revoked]

createdAtMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

lastUsedAtMs(integer | null)<int64>nullable
revokedAtMs(integer | null)<int64>nullable
ruTodayinteger<int64>

Relay Units.

Possible values: >= 0

ApiKey
{
"keyId": "string",
"label": "string",
"prefix": "string",
"scopes": [
"relay"
],
"policy": {
"receiverAllowList": [
"erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e"
],
"functionAllowList": [
"string"
],
"maxRuPerSenderPerDay": 0,
"maxRuPerDay": 0,
"ipAllowList": [
"string"
]
},
"status": "active",
"createdAtMs": 0,
"lastUsedAtMs": 0,
"revokedAtMs": 0,
"ruToday": 0
}