TheHive — API
TheHivevv6.0.0 Read the vendor's spec ↗
- 274 endpoints
- 8 deprecated
- 4 versions archived since Jul 20, 2026
- Last checked Nov 2, 2026
This guide covers everything you need to make your first successful API call to TheHive.
Get started
$ curl "/api/v1/status" \
-H "Authorization: Bearer $TOKEN"
Set $TOKEN first, then paste.
- Base URL
-
/ - Authenticate
-
Bearer token in the Authorization header
Use your API key as a bearer token in the Authorization header.
3 other schemes
- HTTP basic: username and password
- API key in the THEHIVE-SESSION cookie
- HTTP basic: username and password
What it covers
- Case 28 A case is the primary investigation entity in TheHive.
- Alert 17 An alert is a security event generated by external detection tools such as SIEM, EDR, or threat intelligence platforms.
- Cortex 16 A Cortex analyzer enriches an observable with contextual intelligence and produces a report.
- User 14 You can identify a user by their _id or login.
- Organization 13 An organization is an independent tenant in TheHive with its own users, cases, and settings.
- Share 13 A share is a case-level access grant for a linked organization, with a permission profile and local sharing rules for tasks and observables.
- Case Report Template 11 Case report templates define the layout used to generate reports from case descriptions.
- Email Intake 11 The email intake connector connects TheHive to one or more mailboxes and automatically converts incoming emails into alerts.
- Authentication 8 These endpoints handle authentication for TheHive: signing in and out, activating or deactivating multifactor authentication with a time-based one-time password app, and retrieving the password policy enforced by the…
- Case Report 8 A case report is a generated document that summarizes key data from a case.
- Function 8 A function is a user-defined JavaScript script that processes data and calls TheHive API.
- Task 8 A task is a unit of work tracked within a case.
29 more areas
- Task Log 8 A task log—also referred to as an activity—records actions, observations, and decisions made in response to a task.
- Att&ck 7 Attack techniques, also called patterns, and tactics describe the behaviors and methods used by threat actors.
- Observable 7 Observables are data points tracked within cases and alerts that represent specific events or indicators of suspicious or malicious activity.
- Ttp 7 Tactics, techniques, and procedures (TTPs) record which attack techniques were observed on a case or alert, when they occurred, and optionally how they were carried out—referred to as the procedure.
- Alert Feeder 6 An alert feeder retrieves data from an external system on a schedule and converts it into alerts using a JavaScript function.
- License 6 A license controls the features and quotas available on a TheHive instance.
- Page 6 Pages are structured Markdown documents for documentation within TheHive.
- Taxonomy 6 Taxonomies are catalogs of structured tags used to label cases, alerts, and observables in TheHive.
- Casetemplate 5 Case templates pre-fill fields when creating cases or applying templates to existing cases.
- Dashboard 5 A dashboard compiles and visualizes data to give you key insights at a glance.
- Branding 4 Branding lets you personalize TheHive with your own login page logo, navigation bar logo, favicon, and browser tab title.
- Comment 4 Comments are short conversational notes attached to cases and alerts.
- Customfield 4 Custom fields are additional fields that enrich cases and alerts in TheHive.
- Misp 4 MISP (Malware Information Sharing Platform) is an open-source threat intelligence platform for sharing indicators of compromise (IOCs), tactics, techniques, and procedures (TTPs) across organizations.
- Observable Type 4 Observable types define the category of an observable in TheHive.
- Profile 4 A profile defines the permissions available to a user within an organization in TheHive.
- Views 4 Views save the filters, sort order, displayed columns, and display options applied to a list, so you can reapply them later without rebuilding them each time.
- Alertstatus 3 An alert status represents the current state of an alert and belongs to one of four stages: New, In progress, Closed, or Imported.
- Casestatus 3 A case status represents the current state of a case and belongs to one of three stages: New, In progress, or Closed.
- Config 3 Your personal configuration items, stored as arbitrary JSON values under a key you choose.
- Pagetemplate 3 Case pages are investigation-scoped documents for sharing notes, reports, and other content within a case.
- Query And Export 3 A query is an array of chained steps that lets you search, filter, sort, and paginate data across any entity type.
- Tag 3 Tags are labels assigned to cases, alerts, and observables in TheHive.
- Timeline 3 A case timeline is a chronological view of all events that occurred during the case lifecycle.
- Describe 2 Describe endpoints return metadata about entity models: their properties, each property's data type, cardinality, whether it's aggregable, its index type, and, for enumerated properties, the list of allowed values.
- Status 2 Status endpoints return operational information about your TheHive instance: the platform version, license status, the status of each connector, enabled feature flags, and, for the authenticated endpoint, the Pekko…
- Admin 1 Platform-level administration endpoint for TheHive.
- Audit 1 An audit log entry records a single create, update, delete, merge, or function invocation performed in TheHive, capturing the action, the user who performed it, and the affected objects.
- Permission 1 Permissions are the building blocks of profiles in TheHive.
Open an endpoint for a runnable command, its inputs and what it returns.
Case 28
-
DELETE
/api/v1/case/customField/{cfId}Remove a custom field from a caseLoading…
-
DELETE
/api/v1/case/{caseId}/alert/{alertId}Unlink an alert from a caseLoading…
-
DELETE
/api/v1/case/{caseId}/attachment/{attachmentId}Remove an attachment from a caseLoading…
-
DELETE
/api/v1/case/{idOrName}Delete a caseLoading…
-
GET
/api/v1/case/link/typesList all case link typesLoading…
-
GET
/api/v1/case/{caseId}/attachment/{attachmentId}Get an attachment from a case deprecatedLoading…
-
GET
/api/v1/case/{caseId}/attachment/{attachmentId}/downloadDownload an attachment from a case deprecatedLoading…
-
GET
/api/v1/case/{caseId}/exportExport a case as an archiveLoading…
-
GET
/api/v1/case/{caseId}/linksList similar cases deprecatedLoading…
-
GET
/api/v1/case/{caseId}/similar/{alertOrCaseId}/observablesList observables shared with another case or alertLoading…
-
GET
/api/v1/case/{caseId}/timelineGet the timeline of a caseLoading…
-
GET
/api/v1/case/{idOrName}Get a caseLoading…
-
PATCH
/api/v1/case/_bulkUpdate multiple casesLoading…
-
PATCH
/api/v1/case/{caseId}/attachment/{attachmentId}Update a case attachmentLoading…
-
PATCH
/api/v1/case/{idOrName}Update a caseLoading…
-
POST
/api/v1/caseCreate a caseLoading…
-
POST
/api/v1/case/_bulk/accessSet the access mode of multiple casesLoading…
-
POST
/api/v1/case/_bulk/caseTemplateApply a case template to existing casesLoading…
-
POST
/api/v1/case/_merge/{ids}Merge cases into a new caseLoading…
-
POST
/api/v1/case/importCreate a case from an archiveLoading…
-
POST
/api/v1/case/{caseId}/accessSet the access mode of a caseLoading…
-
POST
/api/v1/case/{caseId}/attachmentsAdd attachments to a caseLoading…
-
POST
/api/v1/case/{caseId}/link/case/addLink a case to another caseLoading…
-
POST
/api/v1/case/{caseId}/link/case/removeRemove a link to another caseLoading…
-
POST
/api/v1/case/{caseId}/link/external/addLink a case to an external URLLoading…
-
POST
/api/v1/case/{caseId}/link/external/removeRemove a link to an external URLLoading…
-
POST
/api/v1/case/{caseId}/observable/_mergeDeduplicate observables in a caseLoading…
-
POST
/api/v1/case/{caseId}/ownerChange the owner organization of a caseLoading…
Alert 17
-
DELETE
/api/v1/alert/{alertId}Delete an alertLoading…
-
DELETE
/api/v1/alert/{alertId}/attachment/{attachmentId}Remove an attachment from an alertLoading…
-
GET
/api/v1/alert/{alertId}Get an alertLoading…
-
GET
/api/v1/alert/{alertId}/attachment/{attachmentId}Get an attachment from an alert deprecatedLoading…
-
GET
/api/v1/alert/{alertId}/attachment/{attachmentId}/downloadDownload an attachment from an alert deprecatedLoading…
-
GET
/api/v1/alert/{alertId}/similar/{alertOrCaseId}/observablesList observables shared with another alert or caseLoading…
-
PATCH
/api/v1/alert/_bulkUpdate multiple alertsLoading…
-
PATCH
/api/v1/alert/{alertId}Update an alertLoading…
-
POST
/api/v1/alertCreate an alertLoading…
-
POST
/api/v1/alert/delete/_bulkDelete multiple alertsLoading…
-
POST
/api/v1/alert/merge/_bulkMerge multiple alerts into a caseLoading…
-
POST
/api/v1/alert/{alertId}/attachmentsAdd attachments to an alertLoading…
-
POST
/api/v1/alert/{alertId}/caseCreate a case from an alertLoading…
-
POST
/api/v1/alert/{alertId}/followFollow an alertLoading…
-
POST
/api/v1/alert/{alertId}/import/{caseId}Import alert observables and procedures into a caseLoading…
-
POST
/api/v1/alert/{alertId}/merge/{caseId}Merge an alert into an existing caseLoading…
-
POST
/api/v1/alert/{alertId}/unfollowUnfollow an alertLoading…
Cortex 16
-
DELETE
/api/v1/connector/cortex/analyzer/template/{analyzerTemplateId}Delete an analyzer templateLoading…
-
GET
/api/v1/connector/cortex/analyzerList available analyzersLoading…
-
GET
/api/v1/connector/cortex/analyzer/template/content/{analyzerId}Get an analyzer template's contentLoading…
-
GET
/api/v1/connector/cortex/analyzer/type/{dataType}List analyzers by observable data typeLoading…
-
GET
/api/v1/connector/cortex/analyzer/{analyzerId}Get an analyzerLoading…
-
GET
/api/v1/connector/cortex/job/{jobId}Get a Cortex jobLoading…
-
GET
/api/v1/connector/cortex/responder/{entityType}/{entityId}List responders available for an entityLoading…
-
GET
/api/v1/connector/cortex/responders/{entityType}List responders available for an entity typeLoading…
-
GET
/api/v1/responder-execution/{scope}/{rootId}List responder executions for a case or alertLoading…
-
GET
/api/v1/responder-execution/{scope}/{rootId}/countCount responder executions for a case or alertLoading…
-
PATCH
/api/v1/connector/cortex/analyzer/template/{analyzerTemplateId}Update an analyzer templateLoading…
-
POST
/api/v1/connector/cortex/actionRun a responderLoading…
-
POST
/api/v1/connector/cortex/actionsRun responders in bulkLoading…
-
POST
/api/v1/connector/cortex/analyzer/templateCreate an analyzer templateLoading…
-
POST
/api/v1/connector/cortex/analyzer/template/_importImport analyzer templates in bulkLoading…
-
POST
/api/v1/connector/cortex/jobRun an analyzer on an observableLoading…
User 14
-
DELETE
/api/v1/user/{userId}Lock a user account deprecatedLoading…
-
DELETE
/api/v1/user/{userId}/forceDelete a user accountLoading…
-
DELETE
/api/v1/user/{userId}/keyRevoke a user API keyLoading…
-
GET
/api/v1/user/currentGet current user infoLoading…
-
GET
/api/v1/user/{userId}Get a user accountLoading…
-
GET
/api/v1/user/{userId}/avatar/{file}Get a user avatarLoading…
-
GET
/api/v1/user/{userId}/keyGet a user API keyLoading…
-
PATCH
/api/v1/user/{userId}Update a user accountLoading…
-
POST
/api/v1/userCreate a user accountLoading…
-
POST
/api/v1/user/current/attachmentsUpload temporary attachmentsLoading…
-
POST
/api/v1/user/{userId}/key/renewRenew a user API keyLoading…
-
POST
/api/v1/user/{userId}/password/changeChange a user account passwordLoading…
-
POST
/api/v1/user/{userId}/password/setSet a user account passwordLoading…
-
PUT
/api/v1/user/{userId}/organisationsSet user account organizationsLoading…
Organization 13
-
DELETE
/api/v1/attachment/{attachmentId}Remove a file from an organizationLoading…
-
DELETE
/api/v1/organisation/{orgId}/link/{otherOrgId}Remove a link between two organizationsLoading…
-
GET
/api/v1/attachment/{attachmentId}Get a file from an organizationLoading…
-
GET
/api/v1/attachment/{attachmentId}/downloadDownload a file from an organizationLoading…
-
GET
/api/v1/organisation/{orgId}Get an organizationLoading…
-
GET
/api/v1/organisation/{orgId}/avatar/{fileHash}Get the avatar of an organizationLoading…
-
GET
/api/v1/organisation/{orgId}/linksList organization linksLoading…
-
GET
/api/v1/sharingProfileList sharing profilesLoading…
-
PATCH
/api/v1/organisation/{orgId}Update an organizationLoading…
-
POST
/api/v1/attachmentAdd files to an organizationLoading…
-
POST
/api/v1/organisationCreate an organizationLoading…
-
PUT
/api/v1/organisation/{orgId}/link/{otherOrgId}Link two organizationsLoading…
-
PUT
/api/v1/organisation/{orgId}/linksReplace all links for an organizationLoading…
Case Report Template 11
-
DELETE
/api/v1/caseReportTemplate/{idOrName}Delete a case report templateLoading…
-
DELETE
/api/v1/caseReportTemplate/{templateId}/attachment/{attachmentId}Remove an attachment from a case report templateLoading…
-
GET
/api/v1/caseReportTemplate/_infoList available widget types and field optionsLoading…
-
GET
/api/v1/caseReportTemplate/{caseReportTemplateId}/exportExport a case report template as a fileLoading…
-
GET
/api/v1/caseReportTemplate/{templateId}Get a case report templateLoading…
-
GET
/api/v1/caseReportTemplate/{templateId}/attachment/{attachmentId}Get an attachment from a case report templateLoading…
-
GET
/api/v1/caseReportTemplate/{templateId}/attachment/{attachmentId}/downloadDownload an attachment from a case report templateLoading…
-
PATCH
/api/v1/caseReportTemplate/{idOrName}Update a case report templateLoading…
-
POST
/api/v1/caseReportTemplateCreate a case report templateLoading…
-
POST
/api/v1/caseReportTemplate/importImport a case report template from a fileLoading…
-
POST
/api/v1/caseReportTemplate/{templateId}/attachmentAdd an attachment to a case report templateLoading…
Email Intake 11
-
DELETE
/api/v1/connector/email-intake/config/{configId}Delete a mailbox configurationLoading…
-
GET
/api/v1/connector/email-intake/config/{configId}Get a mailbox configurationLoading…
-
GET
/api/v1/connector/email-intake/configsGet the email intake module configurationLoading…
-
GET
/api/v1/connector/email-intake/providersList available email intake providersLoading…
-
POST
/api/v1/connector/email-intake/configAdd a mailbox configurationLoading…
-
POST
/api/v1/connector/email-intake/config/authorizationCodeComplete Google Workspace OAuth 2.0 authorizationLoading…
-
POST
/api/v1/connector/email-intake/config/testTest a mailbox connectionLoading…
-
POST
/api/v1/connector/email-intake/foldersList mailbox foldersLoading…
-
POST
/api/v1/connector/email-intake/syncTrigger an immediate email fetchLoading…
-
PUT
/api/v1/connector/email-intake/config/{configId}Update a mailbox configurationLoading…
-
PUT
/api/v1/connector/email-intake/configsUpdate the email intake module settingsLoading…
Authentication 8
-
GET
/api/v1/auth/local/passwordPolicyGet the local authentication password policyLoading…
-
GET
/api/v1/auth/totp/getGet a TOTP secret to set up multifactor authenticationLoading…
-
GET
/api/v1/logoutLog out of your sessionLoading…
-
POST
/api/v1/auth/totp/setActivate multifactor authentication with a TOTP codeLoading…
-
POST
/api/v1/auth/totp/unsetDeactivate multifactor authentication for your accountLoading…
-
POST
/api/v1/auth/totp/unset/{user}Deactivate multifactor authentication for another userLoading…
-
POST
/api/v1/loginLog in to TheHiveLoading…
-
POST
/api/v1/logoutLog out of your sessionLoading…
Case Report 8
-
DELETE
/api/v1/caseReport/{reportId}Delete a case reportLoading…
-
GET
/api/v1/caseReport/renderPreview a case report without savingLoading…
-
GET
/api/v1/caseReport/{reportId}/downloadDownload a case report fileLoading…
-
GET
/api/v1/caseReport/{reportId}/viewView a case report in the browserLoading…
-
PATCH
/api/v1/caseReport/{reportId}Replace the content of a case reportLoading…
-
POST
/api/v1/case/{caseId}/reportGenerate a case report from a templateLoading…
-
POST
/api/v1/case/{caseId}/report/uploadUpload a case report fileLoading…
-
POST
/api/v1/caseReport/renderPreview a case report without savingLoading…
Function 8
-
DELETE
/api/v1/function/{functionId}Delete a functionLoading…
-
GET
/api/v1/function/_context/documentationGet context object documentationLoading…
-
GET
/api/v1/function/{functionId}Get a functionLoading…
-
PATCH
/api/v1/function/{functionId}Update a functionLoading…
-
POST
/api/v1/functionCreate a functionLoading…
-
POST
/api/v1/function/_testTest a functionLoading…
-
POST
/api/v1/function/{function}Invoke a functionLoading…
-
POST
/api/v1/function/{function}/{objectType}/{objectIdOrName}Invoke a function on a case or alertLoading…
Task 8
-
DELETE
/api/v1/task/{taskId}Delete a taskLoading…
-
GET
/api/v1/task/{taskId}Get a taskLoading…
-
GET
/api/v1/task/{taskId}/actionRequiredCheck action required for a taskLoading…
-
PATCH
/api/v1/task/_bulkUpdate multiple tasksLoading…
-
PATCH
/api/v1/task/{taskId}Update a taskLoading…
-
POST
/api/v1/case/{caseId}/taskCreate a task in a caseLoading…
-
PUT
/api/v1/task/{taskId}/actionDone/{orgId}Set action done on a taskLoading…
-
PUT
/api/v1/task/{taskId}/actionRequired/{orgId}Set action required on a taskLoading…
Task Log 8
-
DELETE
/api/v1/log/{logId}Delete a task logLoading…
-
DELETE
/api/v1/log/{logId}/attachments/{attachmentId}Delete an attachment from a task logLoading…
-
GET
/api/v1/log/{caseId}/attachment/{attachmentId}Get an attachment from a task log deprecatedLoading…
-
GET
/api/v1/log/{logId}/attachment/{attachmentId}/downloadDownload an attachment from a task log deprecatedLoading…
-
GET
/api/v1/observable/{observableId}/attachment/{attachmentId}Get an observable attachmentLoading…
-
PATCH
/api/v1/log/{logId}Update a task logLoading…
-
POST
/api/v1/log/{logId}/attachmentsAdd attachments to a task logLoading…
-
POST
/api/v1/task/{taskId}/logCreate a task logLoading…
Att&ck 7
-
DELETE
/api/v1/catalog/{catalogId}Delete an attack technique catalogLoading…
-
DELETE
/api/v1/pattern/{patternId}Delete an attack techniqueLoading…
-
GET
/api/v1/pattern/case/{caseId}List attack techniques linked to a caseLoading…
-
GET
/api/v1/pattern/{patternId}Get an attack techniqueLoading…
-
PATCH
/api/v1/catalog/{catalogId}Update an attack technique catalogLoading…
-
POST
/api/v1/catalogCreate an attack technique catalogLoading…
-
POST
/api/v1/pattern/import/attackImport MITRE ATT&CK techniquesLoading…
Observable 7
-
DELETE
/api/v1/observable/{observableId}Delete an observableLoading…
-
GET
/api/v1/observable/{observableId}Get an observableLoading…
-
GET
/api/v1/observable/{observableId}/attachment/{attachmentId}/downloadDownload an attachment from an observableLoading…
-
PATCH
/api/v1/observable/_bulkUpdate multiple observablesLoading…
-
PATCH
/api/v1/observable/{observableId}Update an observableLoading…
-
POST
/api/v1/alert/{alertId}/observableAdd an observable to an alertLoading…
-
POST
/api/v1/case/{caseId}/observableAdd an observable to a caseLoading…
Ttp 7
-
DELETE
/api/v1/procedure/{procedureId}Delete a TTPLoading…
-
PATCH
/api/v1/procedure/{procedureId}Update a TTPLoading…
-
POST
/api/v1/alert/{alertId}/procedureAdd a TTP to an alertLoading…
-
POST
/api/v1/alert/{alertId}/proceduresAdd multiple TTPs to an alertLoading…
-
POST
/api/v1/case/{caseId}/procedureAdd a TTP to a caseLoading…
-
POST
/api/v1/case/{caseId}/proceduresAdd multiple TTPs to a caseLoading…
-
POST
/api/v1/procedure/delete/_bulkDelete multiple TTPsLoading…
Alert Feeder 6
-
DELETE
/api/v1/connector/alert-feeder/{alertFeederName}Delete an alert feederLoading…
-
GET
/api/v1/connector/alert-feederList all alert feedersLoading…
-
POST
/api/v1/connector/alert-feederCreate an alert feederLoading…
-
POST
/api/v1/connector/alert-feeder/run/{alertFeederName}Run an alert feeder immediatelyLoading…
-
POST
/api/v1/connector/alert-feeder/testTest an alert feeder connectionLoading…
-
PUT
/api/v1/connector/alert-feeder/{alertFeederName}Update an alert feederLoading…
License 6
-
GET
/api/v1/licenseList all licensesLoading…
-
GET
/api/v1/license/challengeGet the license challenge tokenLoading…
-
GET
/api/v1/license/currentGet the current license statusLoading…
-
GET
/api/v1/license/{licenseId}Get a licenseLoading…
-
POST
/api/v1/licenseAdd and activate a licenseLoading…
-
PUT
/api/v1/license/{licenseId}/activateActivate an existing licenseLoading…
Page 6
-
DELETE
/api/v1/case/{caseId}/page/{pageId}Delete a case pageLoading…
-
DELETE
/api/v1/page/{pageId}Delete a Knowledge Base pageLoading…
-
PATCH
/api/v1/case/{caseId}/page/{pageId}Update a case pageLoading…
-
PATCH
/api/v1/page/{pageId}Update a Knowledge Base pageLoading…
-
POST
/api/v1/case/{caseId}/pageCreate a case pageLoading…
-
POST
/api/v1/pageCreate a Knowledge Base pageLoading…
Taxonomy 6
-
DELETE
/api/v1/taxonomy/{taxonomyId}Delete a taxonomyLoading…
-
GET
/api/v1/taxonomy/{taxonomyId}Get a taxonomyLoading…
-
POST
/api/v1/taxonomyCreate a taxonomyLoading…
-
POST
/api/v1/taxonomy/import-zipImport taxonomies from a ZIP archiveLoading…
-
PUT
/api/v1/taxonomy/{taxonomyId}/activateActivate a taxonomyLoading…
-
PUT
/api/v1/taxonomy/{taxonomyId}/deactivateDeactivate a taxonomyLoading…
Casetemplate 5
-
DELETE
/api/v1/caseTemplate/{caseTemplateNameOrId}Delete a case templateLoading…
-
GET
/api/v1/caseTemplate/{caseTemplateNameOrId}Get a case templateLoading…
-
PATCH
/api/v1/caseTemplate/{caseTemplateNameOrId}Update a case templateLoading…
-
POST
/api/v1/caseTemplateCreate a case templateLoading…
-
PUT
/api/v1/caseTemplate/{caseTemplateNameOrId}/pageTemplate/linkLink page templates to a case templateLoading…
Dashboard 5
-
DELETE
/api/v1/dashboard/{dashboardId}Delete a dashboardLoading…
-
GET
/api/v1/dashboard/{dashboardId}Get a dashboardLoading…
-
PATCH
/api/v1/dashboard/{dashboardId}Update a dashboardLoading…
-
POST
/api/v1/dashboardCreate a dashboardLoading…
-
POST
/api/v1/dashboard/{dashboardId}/ownerChange the owner of a dashboardLoading…
Branding 4
-
DELETE
/api/v1/branding/assets/{kind}Delete a branding assetLoading…
-
GET
/api/v1/brandingGet brandingLoading…
-
GET
/api/v1/branding/assets/{kind}Get a branding assetLoading…
-
POST
/api/v1/brandingSet brandingLoading…
Comment 4
-
DELETE
/api/v1/comment/{commentId}Delete a commentLoading…
-
PATCH
/api/v1/comment/{commentId}Update a commentLoading…
-
POST
/api/v1/alert/{alertId}/commentAdd a comment to an alertLoading…
-
POST
/api/v1/case/{caseId}/commentAdd a comment to a caseLoading…
Customfield 4
-
DELETE
/api/v1/customField/{customFieldId}Delete a custom fieldLoading…
-
GET
/api/v1/customFieldList all custom fieldsLoading…
-
PATCH
/api/v1/customField/{customFieldId}Update a custom fieldLoading…
-
POST
/api/v1/customFieldCreate a custom fieldLoading…
Misp 4
-
GET
/api/v1/connector/misp/_syncAlertsTrigger a MISP event synchronizationLoading…
-
GET
/api/v1/connector/misp/statusGet MISP server sync statusLoading…
-
POST
/api/v1/connector/misp/case/importImport a MISP event as a caseLoading…
-
POST
/api/v1/connector/misp/export/{caseId}/{mispName}Export a case to a MISP serverLoading…
Observable Type 4
-
DELETE
/api/v1/observable/type/{typeId}Delete an observable typeLoading…
-
GET
/api/v1/observable/type/{typeId}Get an observable typeLoading…
-
PATCH
/api/v1/observable/type/{typeId}Update the case sensitivity of an observable typeLoading…
-
POST
/api/v1/observable/typeCreate an observable typeLoading…
Profile 4
-
DELETE
/api/v1/profile/{profileId}Delete a profileLoading…
-
GET
/api/v1/profile/{profileId}Get a profileLoading…
-
PATCH
/api/v1/profile/{profileId}Update a profileLoading…
-
POST
/api/v1/profileCreate a profileLoading…
Views 4
-
DELETE
/api/v1/views/{viewsId}Delete a viewLoading…
-
GET
/api/v1/views/{viewsId}Get a viewLoading…
-
PATCH
/api/v1/views/{viewsId}Update a viewLoading…
-
POST
/api/v1/viewsCreate a viewLoading…
Alertstatus 3
-
DELETE
/api/v1/alertStatus/{id}Delete an alert statusLoading…
-
PATCH
/api/v1/alertStatus/{id}Update an alert statusLoading…
-
POST
/api/v1/alertStatusCreate an alert statusLoading…
Casestatus 3
-
DELETE
/api/v1/caseStatus/{id}Delete a case statusLoading…
-
PATCH
/api/v1/caseStatus/{id}Update a case statusLoading…
-
POST
/api/v1/caseStatusCreate a case statusLoading…
Config 3
-
GET
/api/v1/config/userList your configuration itemsLoading…
-
GET
/api/v1/config/user/{path}Get a configuration itemLoading…
-
PUT
/api/v1/config/user/{path}Set a configuration itemLoading…
Pagetemplate 3
-
DELETE
/api/v1/pageTemplate/{pageTemplateId}Delete a case page templateLoading…
-
PATCH
/api/v1/pageTemplate/{pageTemplateId}Update a case page templateLoading…
-
POST
/api/v1/pageTemplateCreate a case page templateLoading…
Query And Export 3
-
GET
/api/v1/exportWarning: This is an unstable route.Loading…
-
GET
/api/v1/export/_fieldsWarning: This is an unstable route.Loading…
-
POST
/api/v1/queryPrimary operations by entity | Entity | Operation | Description | |---|---|---| | Any entity | listAny | Lists all alerts, cases, observables, tasks, and task logs accessible to the current user, in aLoading…
Tag 3
-
DELETE
/api/v1/tag/{tagId}Delete a tagLoading…
-
GET
/api/v1/tag/{tagId}Get a tagLoading…
-
PATCH
/api/v1/tag/{tagId}Update a tagLoading…
Timeline 3
-
DELETE
/api/v1/customEvent/{eventId}Delete a custom eventLoading…
-
PATCH
/api/v1/customEvent/{eventId}Update a custom eventLoading…
-
POST
/api/v1/case/{caseId}/customEventAdd a custom event to a case timelineLoading…
Describe 2
-
GET
/api/v1/describe/_allGet the property metadata of every entity modelLoading…
-
GET
/api/v1/describe/{model}Get the property metadata of an entity modelLoading…
Status 2
-
GET
/api/v1/statusGet the platform statusLoading…
-
GET
/api/v1/status/publicGet the public platform statusLoading…
Admin 1
-
PUT
/api/v1/admin/log/set/{packageName}/{level}Set the log level for a packageLoading…
Audit 1
-
GET
/api/v1/flowGet the audit trail of an objectLoading…
Permission 1
-
GET
/api/v1/permissionList all permissionsLoading…
No endpoint matches. Clear the filter to see all 274.
Change log
-
- +GET /api/v1/caseReportTemplate/{caseReportTemplateId}/export
- +POST /api/v1/caseReportTemplate/import
-
- +GET /api/v1/responder-execution/{scope}/{rootId}
- +GET /api/v1/responder-execution/{scope}/{rootId}/count
- −GET /api/v1/admin/check/stats
- −GET /api/v1/admin/index/status
- −GET /api/v1/admin/stats
- −GET /api/v1/caseReport/formats
- −GET /api/v1/connector/cortex/action/{entityType}/{entityId}
- −GET /api/v1/stream/{streamId}
- −POST /api/v1/admin/check/cancel
- −POST /api/v1/admin/check/{name}/dedup/trigger
- −POST /api/v1/admin/check/{name}/global/trigger
- −POST /api/v1/admin/index/{name}/rebuild
- −POST /api/v1/admin/index/{name}/reindex
- −POST /api/v1/admin/schema/info/{schemaName}
- −POST /api/v1/admin/schema/repair/{schemaName}
- −POST /api/v1/connector/cortex/job/_bulk
- −POST /api/v1/stream
- −POST /api/v1/user/{userId}/login/set
- −PUT /api/v1/admin/check/_all/trigger
- −PUT /api/v1/admin/check/{name}/trigger
-
- ⚠DELETE /api/v1/user/{userId}
- ⚠GET /api/v1/alert/{alertId}/attachment/{attachmentId}
- ⚠GET /api/v1/alert/{alertId}/attachment/{attachmentId}/download
- ⚠GET /api/v1/case/{caseId}/attachment/{attachmentId}
- ⚠GET /api/v1/case/{caseId}/attachment/{attachmentId}/download
- ⚠GET /api/v1/case/{caseId}/links
- ⚠GET /api/v1/log/{caseId}/attachment/{attachmentId}
- ⚠GET /api/v1/log/{logId}/attachment/{attachmentId}/download