Sign in
Anon Keys

List anon keys

Changed on

Supports two mutually exclusive pagination modes. Offset mode uses page and limit and is the default when neither cursor nor search is supplied (first page, default limit). Cursor mode uses cursor and limit, supports search (case-insensitive name match), and returns next_cursor. Sending both page and cursor (or page and search) returns 400.

get/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

Query parameters

pageinteger

Page number (1-indexed) for offset pagination. Declares no schema default so the request validator does not inject one: handlers that omit page see it unset (nil) and default to 1 in code, while cursor-first endpoints (e.g. the project deployments feed) can detect its absence to stay in keyset/search mode. Supplying page selects offset pagination.

limitinteger

Number of items per page (max 100)

cursorstring

Opaque keyset pagination cursor from a previous response's next_cursor — pages forward. Mutually exclusive with page and ending_before; combining them returns 400. When supplied, the request's search and limit must match the values bound to the cursor or the request returns 400.

ending_beforestring

Opaque keyset pagination cursor from a previous response's prev_cursor — pages backward (the page immediately preceding this cursor). Mutually exclusive with page and cursor; combining them returns 400. search and limit must match the values bound to the cursor or the request returns 400.

offsetinteger

Bounded row offset past the keyset anchor named by cursor (forward) or ending_before (backward) — the hybrid jump. Seek to the anchor, then skip this many rows within. Used for numbered jump-to-page: from the current page, seek to its next/prev cursor and offset the remaining pages. Only honored on the cursor pagination path; ignored otherwise.

searchstring

Case-insensitive substring match on the resource name. See the endpoint description for supported pagination modes.

Response

List of anon keys

totalinteger

Total number of items matching the query (so the UI can render numbered pages).

has_moreboolean

Whether a next page exists.

next_cursorstring

Opaque cursor for the next page (cursor pagination only)

prev_cursorstring

Opaque cursor for the previous page (cursor pagination only). Send as ending_before.

Example response

{
  "data": [
    {
      "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 property type changed from no type to object for status

    • ○

      added the new optional query request parameter cursor

    • ○

      added the new optional query request parameter ending_before

    • ○

      added the new optional query request parameter limit

    • ○

      added the new optional query request parameter offset

    • ○

      added the new optional query request parameter page

    • ○

      added the new optional query request parameter search

    • ○

      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