Sign in
Anon Keys

Create anon key

Changed on
post/projects/{id}/anon-keys

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/anon-keys
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Request body

namestring required

Key name for identification. Can only contain letters, numbers, underscores, and hyphens.

permissionsstring[]

Optional list of permissions for this key. If not provided, defaults to auth-only permissions: auth.signup, auth.signin, auth.refresh, auth.logout, auth.password_reset, auth.confirm_email, auth.resend_confirmation. Storage, realtime, and functions permissions must be explicitly added if needed.

Example request

{
  "name": "frontend-app",
  "permissions": [
    "auth.signup",
    "auth.signin",
    "auth.refresh",
    "auth.logout"
  ]
}

Response

Anon key created

idstring uuid required
project_idstring uuid
namestring required
key_valuestring required

JWT token - use this in frontend Authorization header

permissionsstring[]

Permissions granted to this anon key. Auth permissions: auth.signup, auth.signin, auth.refresh, auth.logout, auth.password_reset, auth.confirm_email, auth.resend_confirmation Storage permissions: storage.upload, storage.download, storage.list, storage.delete Realtime permissions: realtime.connect, realtime.subscribe, realtime.publish Functions permissions: functions.invoke

is_defaultboolean

Whether this is the project's configured default anon key. Only one key per project can be default.

created_atstring date-time

Example response

{
  "permissions": [
    "auth.signup",
    "auth.signin",
    "auth.refresh",
    "auth.logout"
  ]
}

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status