Get or search findings for your organization

get/org/findings

Request

  • Base URL: https://api.blumira.com/public-api/v1
  • URL: https://api.blumira.com/public-api/v1/org/findings
  • Auth: HTTP bearer

Query parameters

pageinteger

Page to return, e.g., "2"

page_sizeinteger

Number of records per page to return, e.g., "3"

limitinteger

Maximum number of records to return, e.g., "200"

order_bystring

Order records by field, e.g., "created", "created;asc", "created;desc", "name;desc,created;desc"

blockedboolean

If included, filter findings with blocked either True of False

blocked.eqboolean

If included, filter findings with blocked either True of False

blocked.!eqboolean

If included, filter out findings with blocked either True of False

categoryinteger

Category ID of finding

category.eqinteger

Category ID of finding

category.!eqinteger

Category ID of finding to filter out

category.instring

Comma-separated list of category IDs of findings to include

category.!instring

Comma-separated list of category IDs of findings to filter out

createdstring date-time

Exact time object was created

created_afterstring date-time

Start time of window for search (implied UTC)

created_beforestring date-time

End time of window for search (implied UTC)

created.eqstring date-time

Exact time object was created

created.!eqstring date-time

Filter out findings with the given exact time of creation

created.ltstring date-time

End time of window for search (implied UTC) (exclusive)

created.!ltstring date-time

Start time of window for search (implied UTC) (inclusive)

created.gtstring date-time

Start time of window for search (implied UTC) (exclusive)

created.!gtstring date-time

End time of window for search (implied UTC) (inclusive)

created_bystring uuid

If specified, limit search to findings created_by person with given UUID

modifiedstring date-time

Exact time object was modified

modified_afterstring date-time

Start time of window for search (implied UTC)

modified_beforestring date-time

End time of window for search (implied UTC)

modified.eqstring date-time

Exact time object was modified

modified.!eqstring date-time

Filter out findings with the given exact time of modification

modified.ltstring date-time

End time of window for search (implied UTC) (exclusive)

modified.!ltstring date-time

Start time of window for search (implied UTC) (inclusive)

modified.gtstring date-time

Start time of window for search (implied UTC) (exclusive)

modified.!gtstring date-time

End time of window for search (implied UTC) (inclusive)

modified_bystring uuid

UUID of person who last modified finding

modified_by.eqstring uuid

UUID of person who last modified finding

modified_by.!eqstring uuid

Filter out findings where person who last modified it has the given UUID

modified_by.instring

Comma-separated list of UUIDs of persons who last modified finding

modified_by.!instring

Filter out findings where person who last modified it in the given comma-separated list of UUIDs

namestring

If specified, will limit search to findings with given name

name.eqstring

If specified, will limit search to findings with given name

name.!eqstring

If specified, will filter out findings with given name

name.instring

If specified, will limit search to findings with one of the given comma-separated list of names

name.!instring

If specified, will filter out findings with any of the given comma-separated list of names

name.containsstring

If specified, will limit search to findings with given name substring

name.!containsstring

If specified, will filter out findings with given name substring

name.regexstring

If specified, will limit search to findings with name partially matching given regular expression

name.!regexstring

If specified, will filter out findings with name partially matching given regular expression

priorityinteger

Priority number of finding

priority.eqinteger

Priority number of finding

priority.!eqinteger

Priority number of finding to filter out

priority.instring

Comma-separated list of priority numbers of findings to include

priority.!instring

Comma-separated list of priority numbers of findings to filter out

priority.ltinteger

Minimum priority number of finding to exclude

priority.!ltinteger

Minimum priority number of finding to include

priority.gtinteger

Maximum priority number of finding to exclude

priority.!gtinteger

Maximum priority number of finding to include

resolutioninteger

Resolution ID of finding

resolution.eqinteger

Resolution ID of finding

resolution.!eqinteger

Resolution ID of finding to filter out

resolution.ininteger

Comma-separated list of Resolution IDs of findings to include

resolution.!ininteger

Comma-separated list of resolution IDs of findings to filter out

statusinteger

Status ID of finding

status.eqinteger

Status ID of finding

status.!eqinteger

Status ID of finding to filter out

status.instring

Comma-separated list of status IDs of findings to include

status.!instring

Comma-separated list of status IDs of findings to filter out

status_modified_bystring uuid

UUID of person who last modified finding status

status_modified_by.eqstring uuid

UUID of person who last modified finding status

status_modified_by.!eqstring uuid

UUID of person who last modified finding status

status_modified_by.instring

Comma-separated list of UUIDs of persons who last modified finding status

status_modified_by.!instring

Comma-separated list of UUIDs of persons who last modified finding status to be filtered out

typeinteger

Integer type id

type.eqinteger

Integer type id

type.!eqinteger

Integer type id to filter out

type.instring

Comma-separated list of integer type IDs to include

type.!instring

Comma-separated list of integer type IDs to filter out

Headers

Authorizationstring required

Bearer followed by JWT, e.g., "Bearer eyJh...enA"

Response

A list of findings for your organization

statusstring required

Status of request

Example response

{
  "data": [
    {
      "analysis": "Blumira has detected a portscan from 192.168.26.121 to 192.168.2.203 over 1, 4, 37, 9, and 2 others port(s) from an advanced raw query detector.",
      "created": "2015-07-07T15:49:51.230",
      "finding_id": "aff08432-80ae-8fbe-bcd0-399beb09c6f1",
      "modified": "2015-07-07T15:49:51.230",
      "name": "Active Directory Domain Admin Created",
      "org_id": "aff08432-80ae-8fbe-bcd0-399beb09c6f1",
      "org_name": "My Organization",
      "priority": 4,
      "short_id": "F-24-16-B4B6",
      "status": 40,
      "status_name": "Open",
      "type_name": "Suspect",
      "ui_action_type": 20
    }
  ],
  "links": {
    "next": "/v1/{path}?page=2&page_size=25",
    "self": "/v1/{path}?page=1&page_size=25"
  },
  "meta": {
    "page": 1,
    "page_size": 100,
    "total_items": 156,
    "total_pages": 2
  },
  "status": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.