Skip to main content

CreateApiKeyInputGql

A new API key.

input CreateApiKeyInputGql {
  allowedIps: [String!]
  expiresAt: DateTime
  expiresInDays: Int
  name: String!
  rateLimit: Int
  scope: ApiKeyScope
}

Fields​

CreateApiKeyInputGql.allowedIps ● [String!] list scalar​

IP allowlist — IPv4/IPv6 addresses or CIDR ranges (e.g. 203.0.113.7, 10.0.0.0/8). Empty = any IP

CreateApiKeyInputGql.expiresAt ● DateTime scalar​

Optional absolute expiry (must be in the future)

CreateApiKeyInputGql.expiresInDays ● Int scalar​

Expire this many days from now (1–3650); expiresAt wins when both are given

CreateApiKeyInputGql.name ● String! non-null scalar​

Friendly name for the API key

CreateApiKeyInputGql.rateLimit ● Int scalar​

Rate limit in requests per minute (default: 100)

CreateApiKeyInputGql.scope ● ApiKeyScope enum​

Access scope: READ_ONLY or READ_WRITE

Member Of​

createApiKey mutation