Dregs Devices API

openapi: 3.2.0
info:
  title: Dregs Devices API
  description: 'Customer REST API for sending events and reading fraud scores, identities, devices, escalations, channels, datasets, and mappings.


    Authenticate with a secret key created in the dashboard under Settings > Credentials (security scheme secretKey). Send it as a Bearer token: Authorization: Bearer sk_... The key acts as an admin of that credential''s team. POST /api/events and GET /api/devices/{fingerprint} also accept the credential''s public key (security scheme publicKey, Bearer pk_...). Public keys may be embedded in a browser. Secret keys must not.


    This document is the curated public surface. Dashboard sign-in, billing, team administration, and trainer tools are not included.'
  version: '1.0'
servers:
- url: https://dregs.com
  description: Dregs API
security:
- secretKey: []
tags:
- name: Devices
  description: Devices tracked by Dregs
paths:
  /api/devices/{fingerprint}:
    get:
      tags:
      - Devices
      summary: Get device
      description: Get a single device by fingerprint. Accepts a secret key (sk_) or the credential's public key (pk_).
      operationId: getDevice
      parameters:
      - name: fingerprint
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Device found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Device'
        '401':
          description: Invalid or missing authentication
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Device'
        '404':
          description: Device not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Device'
      security:
      - secretKey: []
      - publicKey: []
    patch:
      tags:
      - Devices
      summary: Update device
      description: Update device fields (e.g., disregarded)
      operationId: updateDevice
      parameters:
      - name: fingerprint
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1PatchDeviceRequest'
        required: true
      responses:
        '200':
          description: Device updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Device'
        '404':
          description: Device not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Device'
      security:
      - secretKey: []
  /api/devices:
    get:
      tags:
      - Devices
      summary: Device list
      description: List devices tracked by Dregs
      operationId: listDevices
      parameters:
      - name: request
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/V1ListDevicesRequest'
      responses:
        '200':
          description: Successfully retrieved devices
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1PageV1Device'
        '401':
          description: Invalid credentials
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1PageV1Device'
      security:
      - secretKey: []
components:
  schemas:
    V1PatchDeviceRequest:
      type: object
      properties:
        disregarded:
          type: boolean
    V1PageV1Device:
      type: object
      description: Paginated response wrapper
      properties:
        pageNumber:
          type: integer
          format: int32
          description: Current page number (0-based)
        pageSize:
          type: integer
          format: int32
          description: Number of items per page
        totalPages:
          type: integer
          format: int64
          description: Total number of pages
        totalElements:
          type: integer
          format: int64
          description: Total number of items across all pages
        content:
          type: array
          description: List of items on this page
          items:
            $ref: '#/components/schemas/V1Device'
        first:
          type: boolean
          description: Whether this is the first page
        last:
          type: boolean
          description: Whether this is the last page
        numberOfElements:
          type: integer
          format: int32
          description: Number of items on this page
    V1Device:
      type: object
      properties:
        fingerprint:
          type: string
        ip:
          type: string
        asn:
          type: string
        asnLabel:
          type: string
        userAgent:
          type: string
        city:
          type: string
        region:
          type: string
        country:
          type: string
        countryCode:
          type: string
        timezone:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        disregarded:
          type: boolean
        disregardedViaIdentity:
          type: boolean
        firstSeenAt:
          type: string
          format: date-time
        lastSeenAt:
          type: string
          format: date-time
    V1ListDevicesRequest:
      type: object
      properties:
        pageNumber:
          type: integer
          format: int32
          minimum: 0
        pageSize:
          type: integer
          format: int32
          maximum: 100
          minimum: 1
        order:
          type: string
          enum:
          - ASC
          - DESC
        sort:
          type: string
        search:
          type: string
        identity:
          type: string
        term:
          type: string
        effectiveTerm:
          type: string
  securitySchemes:
    secretKey:
      type: http
      description: Customer secret key from Settings > Credentials, sent as a Bearer token. The token value starts with sk_. It acts as an admin of that credential's team for every operation in this document. MCP tokens (dmcp_) are refused. Prefer the publicKey scheme on operations that accept a pk_ key.
      scheme: bearer
      bearerFormat: sk_
    publicKey:
      type: http
      description: Customer public key from Settings > Credentials, sent as a Bearer token. The token value starts with pk_. Accepted only by POST /api/events and GET /api/devices/{fingerprint}. It may be embedded in a browser. It cannot call the other operations in this document.
      scheme: bearer
      bearerFormat: pk_