Skip to content
Exofind

    REST API

    CreatedKey

    A newly created key. This is the only response its credential ever appears in.

    Example

    {
      "credential": "exok_4ff6b760264c1918_ePQcdT1O9HSATZoXfDbT8hhHGsP9VpZH",
      "key": {
        "id": "4ff6b760264c1918",
        "description": "the search backend",
        "grants": [
          {
            "permissions": [
              "indexes.read",
              "search"
            ],
            "indexes": [
              "products"
            ]
          }
        ],
        "createdAt": "2026-08-16T12:09:33.198275Z",
        "expiresAt": "2027-01-01T00:00:00Z"
      }
    }

    Properties

    credentialstring
    The generated credential, presented as Authorization: Bearer. Only a hash of it is stored, so this response is the only chance to keep it. A lost credential cannot be recovered and must be replaced.
    Example
    "exok_4ff6b760264c1918_ePQcdT1O9HSATZoXfDbT8hhHGsP9VpZH"
    keyKeyInfo
    The key as a listing will show it from now on.
    Example
    {
      "id": "4ff6b760264c1918",
      "description": "the search backend",
      "grants": [
        {
          "permissions": [
            "indexes.read",
            "search"
          ],
          "indexes": [
            "products"
          ]
        }
      ],
      "createdAt": "2026-08-16T12:09:33.198275Z",
      "expiresAt": "2027-01-01T00:00:00Z"
    }
    5 properties
    idstring
    Key identifier. Server logs record the key ID, never the credential value.
    Example
    "4ff6b760264c1918"
    descriptionstring
    A string describing the key.
    Example
    "the search backend"
    grantsGrant[]
    Grants assigned to the key, with roles expanded into their constituent permissions.
    Example
    {
      "permissions": [
        "indexes.read",
        "search"
      ],
      "indexes": [
        "products"
      ]
    }
    2 properties
    permissionsstring[]
    Permission names, in sorted order.
    indexesstring[]
    Index names and prefix patterns in the order specified.
    createdAtstring
    An ISO 8601 timestamp string defining when the key was created.
    Example
    "2026-08-16T12:09:33.198275Z"
    expiresAtstring
    An ISO 8601 timestamp string defining when the key expires. null for a key that does not expire.
    Example
    "2027-01-01T00:00:00Z"

    Endpoints

    Endpoints where the request or responses uses this type.

    Exofind is built by Level Four AB and is available under the Apache License 2.0.