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

# Get track pause settings

> List active and scheduled per-track alert snoozes across devices and locations



## OpenAPI

````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/policy/getTrackPauseSettings
openapi: 3.0.1
info:
  contact:
    email: developer@rhombussystems.com
  description: >-
    This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token`
    for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```
  title: Rhombus API
  version: '1.0'
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/policy/getTrackPauseSettings:
    post:
      tags:
        - Policy Webservice
      summary: Get track pause settings
      description: >-
        List active and scheduled per-track alert snoozes across devices and
        locations
      operationId: getTrackPauseSettings
      parameters:
        - description: >-
            Authentication scheme identifier. Use `api-token` for standard API
            key authentication, `partner-api-token` for partner API key
            authentication. Must be paired with the `x-auth-apikey` header
            containing your API key.
          example: api-token
          in: header
          name: x-auth-scheme
          required: true
          schema:
            type: string
            default: api-token
            enum:
              - api-token
              - api
              - partner-api-token
              - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Policy_GetTrackPauseSettingsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy_GetTrackPauseSettingsWSResponse'
          description: OK
components:
  schemas:
    Policy_GetTrackPauseSettingsWSRequest:
      type: object
      description: >-
        Request object for listing active per-track alert snoozes. Org is
        resolved from the principal.
    Policy_GetTrackPauseSettingsWSResponse:
      type: object
      description: >-
        Response object listing active and scheduled per-track alert snoozes
        across devices and locations.
      properties:
        error:
          type: boolean
          nullable: true
        errorMsg:
          type: string
          nullable: true
        trackPauses:
          type: array
          description: >-
            All active or scheduled per-track snoozes for the org, across device
            and location scope
          items:
            $ref: '#/components/schemas/Policy_TrackPauseEntry'
          nullable: true
        warningMsg:
          type: string
          nullable: true
    Policy_TrackPauseEntry:
      type: object
      description: A single active or scheduled per-track alert snooze.
      properties:
        activeAfterTimestampSec:
          type: integer
          format: int64
          description: Epoch seconds after which the snooze is active
          nullable: true
        durationSec:
          type: integer
          format: int64
          description: Duration in seconds the snooze remains active
          nullable: true
        policyAlertUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        scope:
          $ref: '#/components/schemas/TrackPauseScopeEnum'
        targetUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        thumbnailLocation:
          type: string
          description: >-
            Thumbnail crop locator, copied from the policy alert this snooze was
            created from; null if no source alert was supplied or its thumbnail
            could not be resolved
          nullable: true
        trackId:
          type: integer
          format: int32
          description: reID stableTrackId that is snoozed
          nullable: true
        uuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
    TrackPauseScopeEnum:
      type: string
      description: Whether the snooze targets a single device or a whole location
      enum:
        - DEVICE
        - LOCATION
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header
        set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey

````