List objects

An object is a named resource whose definition describes the state it accepts. An object can represent a device, user location, counter, or any other stateful entity, including type, retention, and version-history settings.

List fully qualified object names visible to the current API key. Use the optional glob-style pattern to narrow the result set.

Pagination requires next: start with next=0, then pass each returned cursor to the next request until the API returns -1. If a pattern returns no objects, retry without it before assuming the object does not exist.

Use Get an object to retrieve a listed object's definition, or List object segments to browse one namespace level at a time.

GET
{{host}}/v1/object/match?next={{next}}&pattern={{pattern}}
VERB:GET
BASE URL:{{host}}/v1/object/match
QUERY STRING:?next={{next}}&pattern={{pattern}}

Query parameters#

  • nextnumber
    Required

    Pagination cursor (required): use `0` for the first page; thereafter use the value returned by the previous response as the `next` query parameter. The response body returns the cursor for the next page. A value of `-1` means there is no further page — you have the last page of data.

    example: 0
  • patternstring
    Optional

    Optional glob-style pattern to filter.

    Values

    • pattern
    • *pattern
    • pattern*
    • *pattern*
    example: *position169*

Headers#

Send these headers with the request. Names are case-insensitive per HTTP rules.
  • x-api-keyRequired

    Your BigState API key.

    {{apiKey}}
  • Content-TypeRequired

    MIME type of the request body.

    application/json
  • AcceptRequired

    MIME types the client can understand in the response.

    application/json

Need a session token? See Token sign in.

Response parameters#

  • 200Response body · object

    Success. Returns a pagination cursor and the matching object names for this page.

    • nextnumber

      Pagination cursor (required): use `0` for the first page; thereafter use the value returned by the previous response as the `next` query parameter. The response body returns the cursor for the next page. A value of `-1` means there is no further page — you have the last page of data.

      example: 0
    • objectsarray[string]

      Full object names in name@owner form that matched the pattern

  • 401

    Unauthorized.

  • 403

    Access denied. The caller does not have sufficient rights to perform this operation.

  • 400Response body · object

    Bad request.

    {

      "error": 6,

      "desc": "Object must be formatted as object"

    }
    • errornumber

      Numeric error code. Use the response `desc` field for the human-readable explanation.

    • descstring

      Human-readable description of the error.

Examples#

List objects

List objects whose names match a glob pattern (paginated with cursor).

curl https://api.bigstate.dev/v1/object/match?next=0&pattern=*position* \

  --header 'x-api-key: YOUR_API_KEY' \

  --header 'Content-Type: application/json' \

  --header 'Accept: application/json'
DeleteList segments

© 2024 BigState