ApiKeyResult

An API key. The full key is never shown again after it is created.

type ApiKeyResult {
  allowedIps: [String!]
  createdAt: DateTime!
  expiresAt: DateTime
  id: ID!
  isActive: Boolean!
  key: String
  keyPrefix: String!
  lastUsedAt: DateTime
  maskedKey: String
  name: String!
  rateLimit: Int!
  revokedAt: DateTime
  scope: ApiKeyScope!
  usageCount: Int!
}

Fields

ApiKeyResult.allowedIps ● [String!] list scalar

The IP addresses the key may be used from. Empty means any.

ApiKeyResult.createdAt ● DateTime! non-null scalar

When the record was created.

ApiKeyResult.expiresAt ● DateTime scalar

When the key stops working.

ApiKeyResult.id ● ID! non-null scalar

The unique ID of this record.

ApiKeyResult.isActive ● Boolean! non-null scalar

Whether the record is active.

ApiKeyResult.key ● String scalar

Full key — only returned on creation

ApiKeyResult.keyPrefix ● String! non-null scalar

The first characters of the key, to identify it.

ApiKeyResult.lastUsedAt ● DateTime scalar

When the key was last used.

ApiKeyResult.maskedKey ● String scalar

The key with most characters hidden.

ApiKeyResult.name ● String! non-null scalar

The name of the key.

ApiKeyResult.rateLimit ● Int! non-null scalar

How many requests the key may make per period.

ApiKeyResult.revokedAt ● DateTime scalar

When the key was revoked.

ApiKeyResult.scope ● ApiKeyScope! non-null enum

What the key may do.

ApiKeyResult.usageCount ● Int! non-null scalar

How many times the key was used.

Returned By

apiKey query ● apiKeys query ● createApiKey mutation