Magnet Forensics Connector
Magnet Nexus is a cloud-native digital forensics and incident response platform that enables remote evidence collection, centralized case management, and collaborative investigations.
Magnet Nexus is a digital forensics platform by Magnet Forensics that enables remote evidence collection, endpoint management, and case orchestration across enterprise environments. This connector empowers Swimlane Turbine users to automate key Magnet Nexus workflows, including case management, endpoint inventory, evidence collection, and audit log retrievalβwithout writing code. By integrating Magnet Nexus with Swimlane Turbine, security teams can streamline digital investigations, accelerate incident response, and ensure comprehensive evidence handling directly within automated playbooks.
Limitations
None to date.
Supported Versions
This connector uses the Magnet Nexus / Magnet Review REST API. Actions use api/v1.0.
Additional Docs
Configuration
Prerequisites
Before using the Magnet Nexus connector, ensure you have the following:
- A Personal Access Token (PAT) authentication for the Magnet Forensics API, requiring:
- URL: The base URL of your Magnet Nexus instance.
- PAT Token: A valid personal access token generated from your Magnet Nexus account, used for secure API authentication.
Authentication Methods
PAT Token Authentication:
- URL: The endpoint for the Magnet Forensics API.
- PAT Token: Your unique authentication token to access the Magnet Forensics API.
- Verify SSL Certificates: Verify the SSL certificate of the target host.
- HTTP(s) Proxy: An optional proxy to route requests through.
Capabilities
The Magnet Forensics connector has the following capabilities:
- Cancel Inprogess Collection
- Count Endpoints
- Create Case
- Delete a Case
- Get All Cases
- Get Collection by ID
- Get Endpoint JSON Stream
- Get Endpoint by ID
- Get a Case
- List Audit Log Entries
- List Collection Downloads
- List Endpoints
- List Presigned Collection Downloads
- Start Endpoint Collection
Cancel Inprogess Collection
- Requests cancellation of a collection that is queued, collecting, or processing.
Count Endpoints
- Returns the total online and offline endpoints based on the same filters as GET /endpoints.
Create Case
- Creates a new investigation container inside Magnet review.
Delete a Case
- Deletes a case and associated collections. This operation is permanent.
Get All Cases
- Returns a paginated list of all cases created by you and shared with you.
Get Collection by ID
- Returns a collection by id, including its status and agent configuration.
Get Endpoint JSON Stream
- Returns a streamable JSON array for large-scale reporting.
Get Endpoint by ID
- Returns an endpoint by its id.
Get a Case
- Returns a case by id.
List Audit Log Entries
- Returns audit log entries from the specified date and time range, ordered by most recent first.
List Collection Downloads
- Returns downloadable artifacts for a completed collection.
List Endpoints
- Returns a paginated page of endpoints visible to your organization.
List Presigned Collection Downloads
- Returns presigned download URLs for a completed collection's artifact files.
Start Endpoint Collection
- Queues collections for specified endpoints. You can add them to an existing case (caseId), create a new case (caseName), or let the system create one named βAPI Collection - ο»Ώβ. Either caseId OR caseName maybe provided, but not both.
Configurations
Magnet Forensics PAT Token Asset
A PAT token for the Magnet Forensics API.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
pat_token | A PAT token for the Magnet Forensics API. | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Cancel Inprogess Collection
Request cancellation of a collection in Magnet Nexus that is currently queued, collecting, or processing by specifying the collection ID.
Endpoint
- URL: api/v1.0/collections/{{id}}/cancel
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | Parameters for the Cancel Inprogess Collection action |
Input Example
{"path_parameters":{"id":"3a2b2a8a-3c42-44b6-b075-df53a8d4a2c1"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response_text | string | Output field: response_text |
Output Example
{"status_code":204,"response_headers":{"Date":"Mon, 21 Sep 2026 15:34:40 GMT","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-RateLimit-Remaining":"69","X-RateLimit-Reset":"2026-09-21T15:34:41.3654456Z","X...
Count Endpoints
Retrieve the total number of online and offline endpoints in Magnet Nexus using the same filters as the GET /endpoints API.
Endpoint
- URL: api/v1.0/endpoints/count
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.hostname | string | Optional | Case-insensitive substring match against hostname. |
parameters.ip | string | Optional | Substring match against the last-known IP address. |
parameters.os | string | Optional | Case-insensitive substring match against operating system. |
parameters.status | string | Optional | Filter by online status. |
Input Example
{"parameters":{"hostname":"TEAM-APP-ROLE-W","ip":"64.156.33.250","os":"windows","status":"online"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
all | number | Output field: all |
online | number | Output field: online |
offline | number | Output field: offline |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 17:13:13 GMT","Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-...
Create Case
Create a new investigation container in Magnet Nexus by specifying the case name.
Endpoint
- URL: api/v1.0/cases
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Display name for the new case. |
sharingSettings | object | Optional | When true, the case is visible to all users in the organization. |
sharingSettings.isSharedWithOrganization | boolean | Optional | Parameter for Create Case |
Input Example
{"json_body":{"name":"Example Case","sharingSettings":{"isSharedWithOrganization":false}}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response_text | string | Output field: response_text |
Output Example
{"status_code":201,"response_headers":{"Date":"Mon, 21 Sep 2026 15:13:20 GMT","Content-Length":"0","Connection":"keep-alive","Server":"Kestrel","Location":"/api/v1.0/cases/e0dbc451-21fe-4665-8f54-2c5855abbd38","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":...
Delete a Case
Permanently deletes a specified case and all associated collections in Magnet Nexus using the case ID.
Endpoint
- URL: api/v1.0/cases/{{id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | The ID of the case to delete. |
Input Example
{"path_parameters":{"id":"e0dbc451-21fe-4665-8f54-2c5855abbd38"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response_text | string | Output field: response_text |
Output Example
{"status_code":204,"response_headers":{"Date":"Mon, 21 Sep 2026 15:34:40 GMT","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-RateLimit-Remaining":"69","X-RateLimit-Reset":"2026-09-21T15:34:41.3654456Z","X...
Get a Case
Fetch case information from Magnet Nexus using the specified case ID.
Endpoint
- URL: api/v1.0/cases/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | Parameters for the Get a Case action |
Input Example
{"path_parameters":{"id":"5aa20936-d1df-4826-9989-74479123de7c"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
name | string | Name of the resource |
status | string | Status value |
createdAt | string | Output field: createdAt |
isSharedWithOrganization | boolean | Output field: isSharedWithOrganization |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 15:31:01 GMT","Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-...
Get All Cases
Retrieve a paginated list of all Magnet Nexus cases you have created or that are shared with you.
Endpoint
- URL: api/v1.0/cases
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.$top | number | Optional | Page size. Max 100. |
parameters.$skip | number | Optional | Records to skip. |
Input Example
{"parameters":{"$top":1,"$skip":1}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
value | array | Value for the parameter |
value.id | string | Unique identifier |
value.name | string | Name of the resource |
value.status | string | Status value |
value.createdAt | string | Value for the parameter |
value.isSharedWithOrganization | boolean | Value for the parameter |
count | number | Count value |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 15:19:14 GMT","Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-...
Get Collection by ID
Retrieve a collection from Magnet Nexus by its ID, including detailed status and agent configuration information.
Endpoint
- URL: api/v1.0/collections/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | The ID of the collection to return. |
Input Example
{"path_parameters":{"id":"3a2b2a8a-3c42-44b6-b075-df53a8d4a2c1"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
caseId | string | Unique identifier |
status | string | Status value |
createdAt | string | Output field: createdAt |
startedAt | string | Output field: startedAt |
completedAt | string | Output field: completedAt |
config | object | Output field: config |
config.endpoints | array | Output field: config.endpoints |
config.containerType | string | Type of the resource |
config.processingMode | string | Output field: config.processingMode |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 15:45:47 GMT","Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-...
Get Endpoint by ID
Fetch details of a specific endpoint in Magnet Nexus using its unique ID.
Endpoint
- URL: api/v1.0/endpoints/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | The ID of the endpoint. |
Input Example
{"path_parameters":{"id":"4e4e3f5d-d6e1-45d6-9200-410620fd3085_626ecdde-da3a-47f2-8176-3921fdfcb2d6_f64ac0a7-edb3-4239-8334-7ca07734dc9f"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
hostname | string | Name of the resource |
ip | string | Output field: ip |
os | string | Output field: os |
isOnline | boolean | Output field: isOnline |
lastSeen | string | Output field: lastSeen |
agentVersion | string | Output field: agentVersion |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 17:17:20 GMT","Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-...
Get Endpoint JSON Stream
Retrieve a streamable JSON array from Magnet Nexus for efficient large-scale reporting and data export.
Endpoint
- URL: api/v1.0/endpoints/export
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.limit | number | Optional | Page size. Default 10000, max 50000. |
parameters.startFromId | string | Optional | Id to resume from for pagination/recovery. |
parameters.hostname | string | Optional | Case-insensitive substring match against hostname. |
parameters.ip | string | Optional | Substring match against the last-known IP address. |
parameters.os | string | Optional | Case-insensitive substring match against operating system. |
parameters.status | string | Optional | Filter by online status. |
Input Example
{"parameters":{"limit":100,"startFromId":"4e4e3f5d-d6e1-45d6-9200-410620fd3085_626ecdde-da3a-47f2-8176-3921fdfcb2d6_f64ac0a7-edb3-4239-8334-7ca07734dc9f","hostname":"TEAM-APP-ROLE-W","ip":"64.156.33.250","os":"windows","status":"online"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 17:23:07 GMT","Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-...
List Audit Log Entries
Retrieve audit log entries from Magnet Nexus within a specified date and time range, ordered by most recent first.
Endpoint
- URL: api/v1.0/audits/audit-log-entries
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.startTime | number | Required | The start of the date range as a Unix timestamp in seconds. |
parameters.endTime | number | Required | The end of the date range as a Unix timestamp in seconds. |
Input Example
{"parameters":{"startTime":1789990080,"endTime":1790026080}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 17:29:20 GMT","Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-...
List Collection Downloads
Retrieve downloadable artifacts for a completed collection in Magnet Nexus using the specified collection ID.
Endpoint
- URL: api/v1.0/collections/{{id}}/downloads
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | The ID of the collection to list downloads for. |
Input Example
{"path_parameters":{"id":"3a2b2a8a-3c42-44b6-b075-df53a8d4a2c1"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
collectionStatus | string | Status value |
hasAvailableDownloads | boolean | Output field: hasAvailableDownloads |
downloads | array | Output field: downloads |
downloads.id | string | Unique identifier |
downloads.type | string | Type of the resource |
downloads.fileName | string | Name of the resource |
downloads.isReady | boolean | Output field: downloads.isReady |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 16:44:38 GMT","Content-Type":"application/problem+json","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-RateLim...
List Endpoints
Retrieve a paginated list of all endpoints accessible to your organization in Magnet Nexus.
Endpoint
- URL: api/v1.0/endpoints
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.$top | number | Optional | Page size. Default 20, max 100. |
parameters.$skip | number | Optional | Records to skip. |
parameters.hostname | string | Optional | Case-insensitive substring match against hostname. |
parameters.ip | string | Optional | Substring match against the last-known IP address. |
parameters.os | string | Optional | Case-insensitive substring match against operating system. |
parameters.status | string | Optional | Filter by online status. |
Input Example
{"parameters":{"$top":1,"$skip":1,"hostname":"TEAM-APP-ROLE-W","ip":"64.156.33.250","os":"windows","status":"online"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
value | array | Value for the parameter |
value.id | string | Unique identifier |
value.hostname | string | Name of the resource |
value.ip | string | Value for the parameter |
value.os | string | Value for the parameter |
value.isOnline | boolean | Value for the parameter |
value.lastSeen | string | Value for the parameter |
value.agentVersion | string | Value for the parameter |
count | number | Count value |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 21 Sep 2026 17:01:38 GMT","Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Server":"Kestrel","Strict-Transport-Security":"max-age=63072000; includeSubDomains; preload","Content-Security-Policy":"default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * dat...","X-XSS-Protection":"1","X-Content-Type-Options":"nosniff","X-Frame-Options":"DENY","X-RateLimit-Limit":"70","X-...
List Presigned Collection Downloads
Retrieve presigned download URLs for artifact files from a completed collection in Magnet Nexus using the collection ID.
Endpoint
- URL: api/v1.0/collections/{{id}}/downloads/files
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.fileId | string | Optional | The ID of the file to list presigned download URLs for. |
path_parameters.id | string | Required | The ID of the collection to list presigned download URLs for. |
Input Example
{"parameters":{"fileId":"ec0ad3a6-f27c-47e8-8609-3913b1ddaab7"},"path_parameters":{"id":"3a2b2a8a-3c42-44b6-b075-df53a8d4a2c1"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"id":"3a2b2a8a-3c42-44b6-b075-df53a8d4a2c1","type":"csv","fileName":"collection_downloads.csv","downloadUrl":"https://example.com/collection_downloads.csv","expiresAt":1726861200}]}
Start Endpoint Collection
Queue data collections for specified endpoints in Magnet Nexus, associating them with an existing case or creating a new one based on provided case details.
Endpoint
- URL: api/v1.0/collections
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
caseId | string | Optional | Existing case to attach the collections to. Mutually exclusive with caseName. |
caseName | string | Optional | Name for a new case to be created for these collections. |
endpoints | array | Optional | One or more endpoints to start collecting from. |
endpoints.id | string | Optional | Opaque endpoint id, exactly as returned by GET /endpoints. |
artifactGroups | array | Optional | Artifact groups to include in the collection. Empty array means no artifacts. Valid values - Additional Sources, Application Usage, Cloud Storage, Communication, Connected Devices, Documents, Email & Calendar, Encryption & Credentials, File Log, Location & Travel, Media, Memory, Operating System, Volatile Artifacts, Web Related. |
isMemoryIncluded | boolean | Optional | When true, includes Windows memory applications in the collection. |
containerType | string | Optional | Output container format for a collection's exported data. |
processingMode | string | Optional | Server-side processing strategy for a collection. |
targetedLocations | object | Optional | Filesystem paths to collect, grouped by operating system, attached to a POST /collections request body. |
targetedLocations.windows | array | Optional | Locations to collect from Windows endpoints. |
targetedLocations.windows.path | string | Optional | Filesystem path. |
targetedLocations.windows.description | string | Optional | Optional human label. When omitted or blank, the server uses the path itself as the description so each entry has a unique identifier downstream. |
Input Example
{"json_body":{"caseName":"Example Case","endpoints":[{"id":"d792a06d-74e4-460e-afe7-0784f65ed22c_08bb4519-879b-45f0-9df5-2b497b1ba556_261b7c4d-4f68-4b69-a0c3-017e43661673"},{"id":"d792a06d-74e4-460e-afe7-0784f65ed22c_4f9e2c81-bd35-4a78-b9c1-5e8d6f1a3c47_9b3a7e15-2c84-4d6f-a019-7e5b3c8d2f64"}],"artifactGroups":["Volatile Artifacts","Operating System"],"isMemoryIncluded":false,"containerType":"zip","processingMode":"collectAndProcess","targetedLocations":{"windows":[{"path":"C:\\Evidence"},{"path":"C:\\Users\\[user_name]\\Documents","description":"User profile documents"},{"path":"C:\\Users\\aUser\\Documents\\*\\*","description":"All Documents Subdirectories"},{"path":"C:\\Users\\aUser\\Documents\\*.*","description":"All Files"},{"path":"C:\\Users\\aUser\\Documents\\*.txt","description":"All Text Files"},{"path":"C:\\Users\\*\\Documents\\*","description":"All Files In Any directory segment"}]}}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
caseId | string | Unique identifier |
createdAt | string | Output field: createdAt |
collections | array | Output field: collections |
collections.id | string | Unique identifier |
collections.endpointId | string | Unique identifier |
collections.status | string | Status value |
Output Example
{"status_code":201,"response_headers":{},"reason":"OK","json_body":{"caseId":"7ea2a85a-eb3e-44b0-90db-bc78bd77ab0c","createdAt":"2026-05-30T15:04:21Z","collections":[{},{}]}}
Response Headers
Header | Description | Example |
|---|---|---|
api-supported-versions | HTTP response header: api-supported-versions | 1.0 |
Connection | HTTP response header: Connection | keep-alive |
Content-Length | The length of the response body in bytes | 0 |
Content-Security-Policy | HTTP response header: Content-Security-Policy | default-src https: wss: data: blob: 'unsafe-eval' 'unsafe-inline'; img-src * data: 'self'; object-src 'none'; frame-ancestors 'none' |
Content-Type | The media type of the resource | application/problem+json |
Date | The date and time at which the message was originated | Mon, 21 Sep 2026 15:13:20 GMT |
Location | The URL to redirect a page to | /api/v1.0/cases/e0dbc451-21fe-4665-8f54-2c5855abbd38 |
Server | Information about the software used by the origin server | Kestrel |
Strict-Transport-Security | HTTP response header: Strict-Transport-Security | max-age=63072000; includeSubDomains; preload |
Transfer-Encoding | HTTP response header: Transfer-Encoding | chunked |
X-Content-Type-Options | HTTP response header: X-Content-Type-Options | nosniff |
X-Frame-Options | HTTP response header: X-Frame-Options | DENY |
X-Magnet-Workspace-Id | HTTP response header: X-Magnet-Workspace-Id | 4e4e3f5d-d6e1-45d6-9200-410620fd3085 |
X-RateLimit-Limit | The number of requests allowed in the current rate limit window | 70 |
X-RateLimit-Remaining | The number of requests remaining in the current rate limit window | 69 |
X-RateLimit-Reset | The time at which the current rate limit window resets | 2026-09-21T15:45:48.5055350Z |
X-XSS-Protection | HTTP response header: X-XSS-Protection | 1 |