Typesense · Schema

ApiKey

Full-Text SearchOpen SourceSearch EngineTypo ToleranceVector Search

Properties

Name Type Description
id integer Numeric ID of the API key.
value string Full API key value. Only returned on creation.
value_prefix string First few characters of the key for identification.
description string Human-readable description.
actions array
collections array
expires_at integer
View JSON Schema on GitHub

JSON Schema

typesense-apikey-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiKey",
  "title": "ApiKey",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Numeric ID of the API key."
    },
    "value": {
      "type": "string",
      "description": "Full API key value. Only returned on creation."
    },
    "value_prefix": {
      "type": "string",
      "description": "First few characters of the key for identification."
    },
    "description": {
      "type": "string",
      "description": "Human-readable description."
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "collections": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expires_at": {
      "type": "integer",
      "format": "int64"
    }
  }
}