v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB

Footage

Get Streaming Token

This is a prerequisite to stream live or historical footage. It returns a JWT (JSON Web Token) which provides access to the streaming endpoint for 30 minutes. For detailed information on streaming footage, refer to <a href="https://apidocs.verkada.com/reference/getfootagestreamviewv1">Stream Footage (Live or Historical)</a>.

get/cameras/v1/footage/token

Query parameters

exclude_accessible_resourcesboolean

If true, omits accessibleCameras and accessibleSites from the response to reduce payload size.

Response

accessibleCamerasstring[]

Allowed cameras for footage streaming for the JWT based on the provided API key. Omitted if exclude_accessible_resources is true.

accessibleSitesstring[]

Allowed sites for footage streaming for the JWT based on the provided API key. Omitted if exclude_accessible_resources is true.

expirationinteger required

The expiration time for the JWT in seconds from now.

expiresAtinteger required

The expiration time for the JWT in as an epoch timestamp (in seconds).

jwtstring required

The JWT used to to stream footage. The token will expire after the expiration timestamp specified in the request. The token has permission to view streams that are live, history, or both based on the configuration of the API key provided. The token has permission to stream from certain cameras based on the configuration of the API key.

permissionstring[] required

Footage streaming permissions for the JWT based on the provided API key.

Example response

{
  "accessibleCameras": [
    "fb7ca55b-d122-4194-8828-4fc0470f0250"
  ],
  "accessibleSites": [
    "a981fcc7-31f4-4c13-b70f-cd1cc1a13ea5",
    "9e56ce44-28f2-497e-97f8-9b88df59663a"
  ],
  "expiration": 3600,
  "expiresAt": 1667145565,
  "jwt": "jwt_header.payload.signature",
  "permission": [
    "live",
    "history"
  ]
}