Deployment
72 endpoints.
Scanners
POST /api/v1/scanner_communication/completed_tasks
Scanner Completed Tasks
Request body: ScannerDataSource
Responses: 200, 400, 401, 500
POST /api/v1/scanner_communication/new_tasks
Scanner New Tasks
Request body: ScannerDataSource
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanner-tasks
List Scanner Tasks
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanner-tasks/search
Search Scanner Tasks
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
search | query | yes | Search query |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanner-tasks/status
Scanner Tasks Status
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanner-tasks/type
Scanner Tasks Type
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanner-tasks/zone
Scanner Tasks Zone
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanner-tasks/{id}
Get Scanner Task
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanners
List Scanners
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
DELETE /api/v1/validation-operations/scanners/{id}
Delete Scanner
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanners/{id}
Get Scanner
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/validation-operations/scanners/{id}
Update Scanner
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: ScannerUpdate
Responses: 200, 400, 401, 500
Scanners / Groups
GET /api/v1/validation-operations/scanner-groups
List Groups
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/validation-operations/scanner-groups
Create Group
Request body: ScannerGroup
Responses: 200, 400, 401, 500
DELETE /api/v1/validation-operations/scanner-groups/{id}
Delete Group
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/scanner-groups/{id}
Get Group
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/validation-operations/scanner-groups/{id}
Update Group
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: ScannerGroup
Responses: 200, 400, 401, 500
Scanners / Public Pool
service-provider shared pools
GET /api/v1/validation-operations/public-scanner-groups
List Public Groups
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/validation-operations/public-scanner-groups
Create Public Group
Request body: PublicScannerGroup
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/public-scanner-groups/options
List Public Group Options
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
DELETE /api/v1/validation-operations/public-scanner-groups/{id}
Delete Public Group
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/public-scanner-groups/{id}
Get Public Group
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/validation-operations/public-scanner-groups/{id}
Update Public Group
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: PublicScannerGroup
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/public-scanners
List Public Scanners
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/public-scanners/source-ips
List Public Scanner Source I Ps
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
DELETE /api/v1/validation-operations/public-scanners/{id}
Delete Public Scanner
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/public-scanners/{id}
Get Public Scanner
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/validation-operations/public-scanners/{id}
Update Public Scanner
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: PublicScannerUpdate
Responses: 200, 400, 401, 500
Apex / Public Pool
service-provider shared pools
GET /api/v1/validation-operations/public-apex
List Public Apex Appliances
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
DELETE /api/v1/validation-operations/public-apex/{id}
Delete Public Apex Appliance
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/public-apex/{id}
Get Public Apex Appliance
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/validation-operations/public-apex/{id}
Update Public Apex Appliance
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Apex
GET /api/v1/apex/engagements/{id}/intel/applications
Applications
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/apex/engagements/{id}/intel/assets/search
Assets Search
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
search | query | yes | Search query |
Responses: 200, 400, 401, 500
GET /api/v1/apex/engagements/{id}/intel/attack-surface
Attack Surface
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/apex/engagements/{id}/intel/domains
Domains
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/apex/engagements/{id}/intel/findings
Apex Apex Findings
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/apex/engagements/{id}/intel/repositories
Repositories
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/apex/engagements/{id}/intel/vulnerabilities
Vulnerabilities
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/apex/engagements/{id}/scope
Scope
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/apex_communication/completed_tasks
Apex Completed Tasks
Request body: ApexCompletedTasksRequest
Responses: 200, 400, 401, 500
POST /api/v1/apex_communication/findings
Apex Communication Apex Communication Findings
Responses: 200, 400, 401, 500
POST /api/v1/apex_communication/llm/completions
Apex LLM Completion
Request body: ApexLLMCompletionRequest
Responses: 200, 400, 401, 500
GET /api/v1/apex_communication/llm/completions/{requestID}
Apex LLM Completion Result
| Parameter | In | Required | Description |
|---|---|---|---|
requestID | path | yes | requestID identifier |
Responses: 200, 400, 401, 500
POST /api/v1/apex_communication/new_tasks
Apex New Tasks
Request body: ApexDataSource
Responses: 200, 400, 401, 500
POST /api/v1/apex_communication/session
Session Update
Request body: ApexSessionUpdate
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/apex
List Apex Appliances
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/apex/campaigns
List Campaigns
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/validation-operations/apex/campaigns
Create Campaign
Request body: ApexCampaignCreate
Responses: 200, 400, 401, 500
DELETE /api/v1/validation-operations/apex/campaigns/{id}
Delete Campaign
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/apex/campaigns/{id}
Get Campaign
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/validation-operations/apex/campaigns/{id}
Update Campaign
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: ApexCampaign
Responses: 200, 400, 401, 500
POST /api/v1/validation-operations/apex/campaigns/{id}/run
Run Campaign
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/apex/search
Search Apex Appliances
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
search | query | yes | Search query |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/apex/tasks
List Apex Tasks
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/validation-operations/apex/tasks
Create Apex Task
Request body: ApexTaskCreate
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/apex/tasks/status
Apex Tasks Status
Responses: 200, 400, 401, 500
DELETE /api/v1/validation-operations/apex/tasks/{id}
Delete Apex Task
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/apex/tasks/{id}
Get Apex Task
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/validation-operations/apex/tasks/{id}
Update Apex Task
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: ApexTask
Responses: 200, 400, 401, 500
POST /api/v1/validation-operations/apex/tasks/{id}/cancel
Cancel Apex Task
Cancel a running Apex task
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
DELETE /api/v1/validation-operations/apex/{id}
Delete Apex Appliance
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/validation-operations/apex/{id}
Get Apex Appliance
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/validation-operations/apex/{id}
Update Apex Appliance
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Agents
GET /api/v1/operating_systems
Operating Systems Operating Systems Operating Systems
Responses: 200, 400, 401, 500
GET /api/v1/security-operations/telemetry/agents
List Agents
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/security-operations/telemetry/agents/operating_systems
Security-operations Security-operations Operating Systems
Responses: 200, 400, 401, 500
GET /api/v1/security-operations/telemetry/agents/resources/{id}
Resource History
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/security-operations/telemetry/agents/search
Search Agents
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
search | query | yes | Search query |
Responses: 200, 400, 401, 500
DELETE /api/v1/security-operations/telemetry/agents/{id}
Delete Agent
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/security-operations/telemetry/agents/{id}
Get Agent
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/security-operations/telemetry/agents/{id}
Update Agent
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: AgentUpdate
Responses: 200, 400, 401, 500