Settings API

Many APIs require some sort of secret or token to be able to work on them. They are usually stored in environment variables in personal use, like OPENAI_API_KEY or MISTRAL_API_KEY.

For added security, the Lumigator API allows the user to store secrets as encoded values in its database, which will be used in requests but will not be returned in the API.

Endpoints

GET /api/v1/settings/secrets/

List Secrets

Lists all API configured secret names (and descriptions) stored in Lumigator.

Status Codes:

  • 200 OK – Successful Response

DELETE /api/v1/settings/secrets/{secret_name}

Delete Secret

Deletes a secret identified by its name.

Parameters:

  • secret_name (string)

Status Codes:
PUT /api/v1/settings/secrets/{secret_name}

Upload Secret

Uploads a secret for use in Lumigator.

Lumigator uses different secrets for purposes such as external API calls. The user can upload new values for these secrets, but they cannot retrieve those values.

Parameters:

  • secret_name (string)

Status Codes: