> ## Documentation Index
> Fetch the complete documentation index at: https://docs.marcus.involvecloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify a token

> Returns the tenant id, token name, and granted scopes. Useful for smoke-testing that your bearer header is set correctly and that the token targets the tenant you expect.

Updated 23 Oct 2026 15:20 · page cc210eb


## OpenAPI

````yaml api-reference/openapi.json GET /pub/v1/ping
openapi: 3.1.0
info:
  title: M.A.R.C.U.S. Public API
  version: 1.0.0
  summary: Programmatic access to a customer's AV fleet.
  description: >-
    Read-only integration API for the M.A.R.C.U.S. monitoring platform. Use it
    to sync device inventory into a CMDB, mirror alerts into an incident tool,
    or feed dashboards with live fleet state. Every route is scoped to the
    token's tenant — one token, one customer's data.


    Polling once a minute is ample for most use cases. Cursor-based pagination
    keeps list endpoints stable under concurrent inserts.
servers:
  - url: https://api.uat.involvecloud.com
    description: UAT
  - url: https://api.involvecloud.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Meta
    description: Health and identity of the calling token.
  - name: Devices
    description: >-
      AV endpoints under management — displays, cameras, DSPs, control
      processors.
  - name: Firmware
    description: >-
      Firmware versions across the fleet, against the targets set on the
      Firmware page. Needs the view.firmware scope.
  - name: Hierarchy
    description: 'Physical structure: buildings and rooms.'
  - name: Assets
    description: >-
      The CMDB inventory — every physical thing the tenant owns, monitored or
      not. Broader than Devices: includes mounts, cables, spares, retired gear.
  - name: Alerts
    description: Open + historical incidents raised on devices and collectors.
  - name: Events
    description: Device-emitted events — state changes, adapter messages, telemetry deltas.
  - name: Audit
    description: >-
      The tenant's audit trail of changes and commands. Needs the view.audit
      scope.
  - name: Room Readiness
    description: >-
      Results of each room's power schedule (switched off at night, on in the
      morning) and readiness checks (a test routine, down to every step). Needs
      the nightly.view scope.
paths:
  /pub/v1/ping:
    get:
      tags:
        - Meta
      summary: Verify a token
      description: >-
        Returns the tenant id, token name, and granted scopes. Useful for
        smoke-testing that your bearer header is set correctly and that the
        token targets the tenant you expect.
      responses:
        '200':
          description: Valid token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponse'
              example:
                tenant_id: 00000000-0000-0000-0000-000000000000
                token_name: Facilities BI export
                scopes:
                  - view.dashboard
                time: '2026-08-26T09:15:22Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    PingResponse:
      type: object
      required:
        - tenant_id
        - token_name
        - scopes
        - time
      properties:
        tenant_id:
          type: string
          format: uuid
        token_name:
          type: string
        scopes:
          type: array
          items:
            type: string
        time:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - code
          properties:
            message:
              type: string
              description: Human-readable summary. Not intended for parsing.
            code:
              type: string
              enum:
                - bad_request
                - unauthorized
                - forbidden
                - not_found
                - internal_error
                - error
              description: Stable machine-readable identifier.
      example:
        error:
          message: 'token missing scope: view.dashboard'
          code: forbidden
  responses:
    Unauthorized:
      description: Missing, malformed, revoked, or expired bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: avb_<prefix>_<secret>
      description: >-
        Mint a token from the portal at Settings → API tokens. Send it as
        `Authorization: Bearer avb_...` on every request. Query-string tokens
        are NOT accepted — the URL ends up in access logs.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.