Cyberhaven public api (0.0.1)

Download OpenAPI specification:Download

/api/rest/v1/endpoints/list

Request Body schema: application/json

	object (endpointsstatusapi.Filters)
page_id	string
size	number
sort_ascending	boolean
sort_by	number (endpointsstatusapi.Column) Enum: "" "error" "group" "hostname" "lightbeam_version" "" "os" "os_version" "report_time" "status_and_required_action"

Responses

Request samples

Payload

Content type

application/json

{"filters": {"deleted": true,
"groups": ["string"
],
"hostnames": ["string"
],
"ids": ["string"
],
"lightbeam_versions": ["string"
],
"not_statuses": ["chrome_extension_has_policy_conflict"
],
"os_versions": ["string"
],
"oses": ["string"
],
"status_groups": ["string"
],
"statuses": ["chrome_extension_has_policy_conflict"
]
},
"page_id": "string",
"size": 0,
"sort_ascending": true,
"sort_by": ""
}

Response samples

Content type

application/json

{"next_page_id": "string",
"records": [{"deleted": true,
"endpoint_id": "string",
"group_id": "string",
"group_name": "string",
"hostname": "string",
"id": "string",
"lightbeam_version": "string",
"os": "string",
"os_version": "string",
"report_time": "2019-08-24T14:15:22Z",
"statuses_and_actions": [{"required_action": "Allow browser services",
"status": "chrome_extension_has_policy_conflict"
}
]
}
],
"total_records": 0
}

/api/rest/v1/incidents/list

Request Body schema: application/json

	object (types.IncidentsFilters) all array filters work like or
page_id	string pagination id
page_size	number amount of data to fetch in one batch
sort_by	string // Possible values of sort are: // * resolution_status -- by resolution status. // * severity -- by severity. // * dataset -- by dataset name. // * dataset_id -- by dataset ID. // * category -- by category name. // * category_id -- by category ID. // * user -- by user name. // * file -- by file name. // * personal_info -- by PII column. // * incident_response // * incident_reactions // * event_time // * assignee
sort_desc	boolean

Responses

Request samples

Payload

Content type

application/json

{"filters": {"assignees": ["string"
],
"category_ids": ["string"
],
"category_names": ["string"
],
"content_tags": ["string"
],
"dataset_ids": ["string"
],
"dataset_names": ["string"
],
"files": ["string"
],
"incident_ids": ["string"
],
"incident_reactions": ["acknowledged"
],
"incident_responses": ["access_restricted"
],
"personal_info": ["string"
],
"resolution_statuses": ["ignored"
],
"severities": ["any"
],
"times_filter": {"end_time": "2019-08-24T14:15:22Z",
"segments": [{"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z"
}
],
"start_time": "2019-08-24T14:15:22Z"
},
"users": ["string"
]
},
"page_id": "string",
"page_size": 0,
"sort_by": "string",
"sort_desc": true
}

Response samples

Content type

application/json

{"incidents": [{"admin_history": [{"assignee": "string",
"new_status": "ignored",
"time": "2019-08-24T14:15:22Z",
"unblocked": true,
"user": "string"
}
],
"alert_id": "string",
"assignee": "string",
"category": {"dataset_ids": ["string"
],
"description": "string",
"exclude_origin": true,
"id": "string",
"name": "string",
"query": {"rules": [{"conditions": [{"case_sensitive": true,
"field_name": "app_main_window_title",
"negated": true,
"operator": "contains",
"selector": "match_all",
"values": [null
]
}
]
}
]
},
"rule": {"allow_request_review": true,
"blocking_action": {"response_duration": {"type": "day",
"value": 0
},
"trigger_after_count": 0,
"trigger_after_period": {"type": "day",
"value": 0
}
},
"blocking_dialog": {"allow_label": "string",
"check_text": "string",
"explanation": "string",
"logo": "string",
"placeholder": "string",
"review_check_text": "string",
"submit_label": "string",
"title": "string"
},
"create_incident": true,
"id": "string",
"incident_action": "block",
"notify_email": "string",
"notify_enabled": true,
"notify_status": "",
"override_enabled": true,
"require_justification": true,
"should_ack_warning": true,
"show_logo": true,
"show_title": true,
"status": "any",
"warning_dialog": {"allow_label": "string",
"check_text": "string",
"explanation": "string",
"logo": "string",
"placeholder": "string",
"review_check_text": "string",
"submit_label": "string",
"title": "string"
}
}
},
"category_last_modified": "2019-08-24T14:15:22Z",
"content_tags": ["string"
],
"data": {"app_commandline": "string",
"app_description": "string",
"app_main_window_title": "string",
"app_name": "string",
"app_package_name": "string",
"blocked": true,
"browser_page_domain": "string",
"browser_page_title": "string",
"browser_page_url": "string",
"category": ["string"
],
"cloud_app": "box",
"cloud_app_account": "string",
"cloud_provider": "box",
"comment": "string",
"content_report_uri": "string",
"content_upload_uri": "string",
"content_uri": "string",
"data_size": 0,
"device_physical_location": "string",
"domain": "string",
"domain_components": {"property1": "string",
"property2": "string"
},
"driver": "string",
"email_account": "string",
"email_groups": ["string"
],
"email_subject": "string",
"endpoint_id": "string",
"event_type": "app_access",
"extension": "string",
"file_size": 0,
"gdrive_file_id": "string",
"group_name": ["string"
],
"hostname": "string",
"job_name": "string",
"keywords": "string",
"links": ["string"
],
"local_file_id": "string",
"local_groups": [{"name": "string",
"sid": "string"
}
],
"local_id": "string",
"local_machine_name": "string",
"local_time": "2019-08-24T14:15:22Z",
"local_user_name": "string",
"local_user_sid": "string",
"location": "cloud_apps",
"location_outline": "string",
"mail_attachment_id": "string",
"md5_hash": "string",
"media_category": "string",
"o365_file_id": "string",
"path": "string",
"path_basename": "string",
"path_components": {"property1": "string",
"property2": "string"
},
"port": "string",
"preexisting": true,
"printer_name": "string",
"quick_xor_hash": "string",
"raw_id": "string",
"removable_device_id": "string",
"removable_device_name": "string",
"removable_device_product_id": "string",
"removable_device_usb_id": "string",
"removable_device_vendor_id": "string",
"salesforce_account_domains": ["string"
],
"salesforce_account_name": "string",
"salesforce_content_document_id": "string",
"sensor_name": "string",
"tags_applied": true,
"url": "string",
"zone": "external"
},
"dataset": {"description": "string",
"id": "string",
"name": "string",
"query": {"rules": [{"conditions": [{"case_sensitive": true,
"field_name": "app_main_window_title",
"negated": true,
"operator": "contains",
"selector": "match_all",
"values": [null
]
}
]
}
]
},
"query_version": 0,
"sensitivity": 0
},
"dataset_last_modified": "2019-08-24T14:15:22Z",
"edge": {"_id": "string",
"content_tags": ["string"
],
"destination": {"app_commandline": "string",
"app_description": "string",
"app_main_window_title": "string",
"app_name": "string",
"app_package_name": "string",
"blocked": true,
"browser_page_domain": "string",
"browser_page_title": "string",
"browser_page_url": "string",
"category": ["string"
],
"cloud_app": "box",
"cloud_app_account": "string",
"cloud_provider": "box",
"comment": "string",
"content_report_uri": "string",
"content_upload_uri": "string",
"content_uri": "string",
"data_size": 0,
"device_physical_location": "string",
"domain": "string",
"domain_components": {"property1": "string",
"property2": "string"
},
"driver": "string",
"email_account": "string",
"email_groups": ["string"
],
"email_subject": "string",
"endpoint_id": "string",
"event_type": "app_access",
"extension": "string",
"file_size": 0,
"gdrive_file_id": "string",
"group_name": ["string"
],
"hostname": "string",
"job_name": "string",
"keywords": "string",
"links": ["string"
],
"local_file_id": "string",
"local_groups": [{"name": "string",
"sid": "string"
}
],
"local_id": "string",
"local_machine_name": "string",
"local_time": "2019-08-24T14:15:22Z",
"local_user_name": "string",
"local_user_sid": "string",
"location": "cloud_apps",
"location_outline": "string",
"mail_attachment_id": "string",
"md5_hash": "string",
"media_category": "string",
"o365_file_id": "string",
"path": "string",
"path_basename": "string",
"path_components": {"property1": "string",
"property2": "string"
},
"port": "string",
"preexisting": true,
"printer_name": "string",
"quick_xor_hash": "string",
"raw_id": "string",
"removable_device_id": "string",
"removable_device_name": "string",
"removable_device_product_id": "string",
"removable_device_usb_id": "string",
"removable_device_vendor_id": "string",
"salesforce_account_domains": ["string"
],
"salesforce_account_name": "string",
"salesforce_content_document_id": "string",
"sensor_name": "string",
"tags_applied": true,
"url": "string",
"zone": "external"
},
"executor_state": {"failed": ["string"
],
"succeeded": ["string"
]
},
"executor_state2": 2,
"flow_id": "string",
"is_direct": true,
"nhops": 0,
"personal_info": ["string"
],
"personal_info_state": 2,
"processing_delay": 0,
"processing_history": ["string"
],
"processing_hops": 0,
"source": {"app_commandline": "string",
"app_description": "string",
"app_main_window_title": "string",
"app_name": "string",
"app_package_name": "string",
"blocked": true,
"browser_page_domain": "string",
"browser_page_title": "string",
"browser_page_url": "string",
"category": ["string"
],
"cloud_app": "box",
"cloud_app_account": "string",
"cloud_provider": "box",
"comment": "string",
"content_report_uri": "string",
"content_upload_uri": "string",
"content_uri": "string",
"data_size": 0,
"device_physical_location": "string",
"domain": "string",
"domain_components": {"property1": "string",
"property2": "string"
},
"driver": "string",
"email_account": "string",
"email_groups": ["string"
],
"email_subject": "string",
"endpoint_id": "string",
"event_type": "app_access",
"extension": "string",
"file_size": 0,
"gdrive_file_id": "string",
"group_name": ["string"
],
"hostname": "string",
"job_name": "string",
"keywords": "string",
"links": ["string"
],
"local_file_id": "string",
"local_groups": [{"name": "string",
"sid": "string"
}
],
"local_id": "string",
"local_machine_name": "string",
"local_time": "2019-08-24T14:15:22Z",
"local_user_name": "string",
"local_user_sid": "string",
"location": "cloud_apps",
"location_outline": "string",
"mail_attachment_id": "string",
"md5_hash": "string",
"media_category": "string",
"o365_file_id": "string",
"path": "string",
"path_basename": "string",
"path_components": {"property1": "string",
"property2": "string"
},
"port": "string",
"preexisting": true,
"printer_name": "string",
"quick_xor_hash": "string",
"raw_id": "string",
"removable_device_id": "string",
"removable_device_name": "string",
"removable_device_product_id": "string",
"removable_device_usb_id": "string",
"removable_device_vendor_id": "string",
"salesforce_account_domains": ["string"
],
"salesforce_account_name": "string",
"salesforce_content_document_id": "string",
"sensor_name": "string",
"tags_applied": true,
"url": "string",
"zone": "external"
},
"weight": 0
},
"event_time": "2019-08-24T14:15:22Z",
"explanation": "string",
"file": "string",
"id": "string",
"incident_reactions": ["acknowledged"
],
"incident_response": "access_restricted",
"outdated_policy": true,
"personal_info": ["string"
],
"reaction_time": "2019-08-24T14:15:22Z",
"resolution_status": "ignored",
"resolution_time": "2019-08-24T14:15:22Z",
"response_time": "2019-08-24T14:15:22Z",
"rule_id": "string",
"severity": "any",
"trigger_time": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"next_page_id": "string",
"total": 0
}

/api/rest/v1/audit-log/dataflow/list

Request Body schema: application/json

	object (types.AdminEventsFilters)
page_id	string
page_size	number

Responses

Request samples

Payload

Content type

application/json

{"filters": {"category_id": "string",
"dataset_id": "string",
"include_cyberhaven": true,
"types": ["created_category"
],
"users": ["string"
]
},
"page_id": "string",
"page_size": 0
}

Response samples

Content type

application/json

{"events": [{"data": {"category": {"dataset_ids": ["string"
],
"description": "string",
"exclude_origin": true,
"id": "string",
"name": "string",
"query": {"rules": [{"conditions": [{"case_sensitive": null,
"field_name": null,
"negated": null,
"operator": null,
"selector": null,
"values": [ ]
}
]
}
]
},
"rule": {"allow_request_review": true,
"blocking_action": {"response_duration": {"type": "day",
"value": 0
},
"trigger_after_count": 0,
"trigger_after_period": {"type": "day",
"value": 0
}
},
"blocking_dialog": {"allow_label": "string",
"check_text": "string",
"explanation": "string",
"logo": "string",
"placeholder": "string",
"review_check_text": "string",
"submit_label": "string",
"title": "string"
},
"create_incident": true,
"id": "string",
"incident_action": "block",
"notify_email": "string",
"notify_enabled": true,
"notify_status": "",
"override_enabled": true,
"require_justification": true,
"should_ack_warning": true,
"show_logo": true,
"show_title": true,
"status": "any",
"warning_dialog": {"allow_label": "string",
"check_text": "string",
"explanation": "string",
"logo": "string",