generated: '2026-07-18'
method: searched
source: https://github.com/CyberGRX/api-examples
docs: https://api.cybergrx.com/v1/swagger/
authentication:
  style: api-key-header
  header: Authorization
  ref: authentication/cybergrx-authentication.yml
versioning:
  scheme: uri-path
  versions: [v1, bulk-v1, v2]
  current: v2
  compatibility: >-
    The CyberGRX API and Bulk API are versioned and documented as maintaining
    backwards compatibility within a version namespace.
  ref: lifecycle/cybergrx-lifecycle.yml
pagination:
  v1:
    style: limit-based
    params: [limit, name]
    notes: >-
      The v1 namespace (https://api.cybergrx.com/v1/) supports standard
      pagination for data retrieval; list calls accept a `limit` query
      parameter and filters such as `name`.
  bulk-v1:
    style: single-request
    notes: >-
      The Bulk API (https://api.cybergrx.com/bulk-v1/) is purpose-built to
      return an entire third-party ecosystem in a single request, eliminating
      client-side pagination. Accepts a `report_date` query parameter.
idempotency:
  supported: false
  notes: >-
    No idempotency-key contract is documented on the public surface. Write
    operations (POST /v1/third-parties, PUT .../scoping, PUT .../tagging) are
    not documented as idempotent.
error_envelope:
  documented: false
  notes: Public error catalog not available (Swagger UI is credential-gated).
rate_limits:
  documented: false
content_type: application/json