Sign in
API Key

Create API Key

Creates an API key and returns the Base64 encoded API key. Expects the Base64 encoded master API key in the header. Use the master API key displayed in the server console at startup.

WARNING: make sure to set the MASTER_KEY_SECRET environment variable to a secret, otherwise your generated API keys will be compromised. For development purposes you may also use the SeekStorm server console command 'create' to create an demo API key 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA='.

post/api/v1/apikey

Headers

apikeystring required

YOUR_MASTER_API_KEY

Request body

indices_maxinteger required

number of indices per API key

indices_size_maxinteger required

combined index size per API key in MB

documents_maxinteger required

combined number of documents in all indices per API key

operations_maxinteger required

operations per month per API key: index/update/delete/query doc

rate_limitinteger nullable

queries per sec per API key

demoboolean

create fixed demo api key instead of random api key for demo purposes (default=false)

Response

API key created, returns Base64 encoded API key

Changes

Changed in 3 of the 11 revisions of this API.13

  • e0feb78665121See the full diff
    • ○

      added the new optional request property demo

      new-optional-request-property

  • 39cce1ef7d951See the full diff
    • ○

      api operation id create_apikey_api removed and replaced with create_api_key

      api-operation-id-removed

  • 4cfd9d95648c11See the full diff
    • ●

      removed the request property demo

      request-property-removed

    • ○

      api operation id create_api_key removed and replaced with create_apikey_api

      api-operation-id-removed