Cybereason CustomDetectionRules API

openapi: 3.1.0
info:
  title: Cybereason Authentication CustomDetectionRules API
  version: 23.x
  description: 'Cybereason EDR/XDR REST API. Exposes Malop investigation, hunting

    via Visual Search, sensor management, isolation rules, custom

    detection rules, reputation lists, threat-intel lookups, malware

    queries, and remediation actions against a Cybereason tenant.


    Best-effort spec derived from publicly indexed Cybereason API

    documentation references (api-doc.cybereason.com URI/endpoints

    pages, docs.cybereason.com 23.2 docs, Cortex XSOAR / Demisto

    Cybereason integration, and the open-source CybereasonAPI

    PowerShell module). Cybereason''s primary API documentation is

    customer/partner-gated; the operational surface modelled here

    matches the publicly described endpoints.


    Authentication is performed via a POST to /login.html which

    returns a JSESSIONID cookie used on subsequent calls. JWT

    authentication is also supported on version 20.1+ deployments.

    '
  contact:
    name: Cybereason Nest
    url: https://nest.cybereason.com/documentation/api-documentation
  license:
    name: Proprietary
servers:
- url: https://{tenant}.cybereason.net
  description: Cybereason tenant
  variables:
    tenant:
      default: example
      description: Your Cybereason tenant hostname prefix.
security:
- SessionCookie: []
tags:
- name: CustomDetectionRules
paths:
  /rest/customRules/decisionFeature/live:
    get:
      tags:
      - CustomDetectionRules
      summary: List active custom detection rules
      responses:
        '200':
          description: Active rules
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomDetectionRule'
  /rest/customRules/decisionFeature/create:
    post:
      tags:
      - CustomDetectionRules
      summary: Create a custom detection rule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDetectionRule'
      responses:
        '200':
          description: Rule created
  /rest/customRules/decisionFeature/update:
    post:
      tags:
      - CustomDetectionRules
      summary: Update a custom detection rule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDetectionRule'
      responses:
        '200':
          description: Rule updated
components:
  schemas:
    CustomDetectionRule:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        rootCause:
          type: string
        malopDetectionType:
          type: string
        severity:
          type: string
        enabled:
          type: boolean
  securitySchemes:
    SessionCookie:
      type: apiKey
      in: cookie
      name: JSESSIONID
      description: Session cookie returned by POST /login.html.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Available on Cybereason 20.1+ for token-based access.
externalDocs:
  description: Cybereason API documentation
  url: https://nest.cybereason.com/documentation/api-documentation