{"info":{"_postman_id":"771e745b-b3f8-4550-afa6-708afb9b5600","name":"NopSec API Documentation","description":"

Welcome to the NopSec API!

\n

Using the NopSec API, you can have visibility into your scanned targets and vulnerabilities, kick off remediation
workflows by creating remediation plans or submitting new exception plans.

\n

Prerequisites

\n

To begin using the NopSec API, you need an active NopSec Account that has been given API access, the API endpoint URL,
and the correct credentials and permissions.

\n

Active Account

\n

A NopSec Account is used to authenticate with the NopSec API.

\n

Please submit a Service Request or contact your Customer Success team to receive your API Key.

\n

Permissions

\n

Each user account within the NopSec platform is assigned to one or more Teams. Each Team is assigned a role which the
user inherits. These roles dictate the permissions a user has within the platform. Your API Key will inherit the same
permissions your user account has and will utilize the highest level of access for each API call.

\n

You may create a new local user manually or ask your Customer Success team to do so with limited permissions if you
prefer to use a service account for your API calls.

\n

API Server

\n

The NopSec API has a single endpoint depending on where your instance is hosted:

\n\n

API Key

\n

Please submit a Support Ticket or contact your Customer Success Team directly and request an API key.

\n

You will need to provide this key with all of your API requests via a header.

\n

Error Codes

\n

HTTP status codes will be returned in the response header in the event there is an error or unaccepted parameter in the
api call. An error message (JSON formatted) will be returned in the response body to help guide you towards creating an
acceptable request.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeMeaning
102Processing
200OK
201Created
204No Content
400Bad Request
401Unauthorized
404Not Found
409Conflict
412Precondition Failed
422Unprocessable Entity
429Too Many Requests (more than 5 per second)
500Internal Server Error
\n

Limitations

\n

Contact your Customer Success Team for details regarding your plan.

\n

Troubleshooting

\n

Before using NopSec APIs, we recommend that you familiarize yourself with
the user documentation. There is a strong correlation between the business
logic of NopSec Platform UI and the API.

\n

You will also find detailed step-by-step instructions for specific use cases, for example, importing asset data and
importing scan data.

\n

If you experience any errors please submit a support ticket in your
customer portal.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Prerequisites","slug":"prerequisites"},{"content":"Error Codes","slug":"error-codes"},{"content":"Limitations","slug":"limitations"},{"content":"Troubleshooting","slug":"troubleshooting"}],"owner":"18883136","collectionId":"771e745b-b3f8-4550-afa6-708afb9b5600","publishedId":"2sA35LWf8F","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-05T14:18:36.000Z"},"item":[{"name":"Prioritize","item":[{"name":"Get Saved Column Presets","id":"22be24f5-4fa4-4093-afa6-908a34225a6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/prioritize/saved-column-group-by?limit=&offset=","description":"

Retrieve a list of your Saved Column Presets that you created within the Prioritize Page or that were assigned\nto you by your Admin team. Column Presets are the specific Columns and their Order in which you would like your\nReport to use.

\n","urlObject":{"path":["prioritize","saved-column-group-by"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"6457d2cf-0d72-4b82-b5c3-694d99ba0616","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/prioritize/saved-column-group-by?limit=&offset=","host":["{{baseUrl}}"],"path":["prioritize","saved-column-group-by"],"query":[{"description":"Number of results to return per page.","key":"limit","value":""},{"description":"The initial index from which to return the results.","key":"offset","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"client\": \"\",\n \"columns\": [\n {\n \"column\": {\n \"column\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_active\": \"\",\n \"rendering_type\": \"DEFAULT\"\n },\n \"id\": \"\",\n \"order\": \"\"\n },\n {\n \"column\": {\n \"column\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_active\": \"\",\n \"rendering_type\": \"DEFAULT\"\n },\n \"id\": \"\",\n \"order\": \"\"\n }\n ],\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"group_by\": \"TARGET\",\n \"column_ids\": [\n \"\",\n \"\"\n ],\n \"sort_by\": \"\",\n \"is_favorite\": \"\"\n },\n {\n \"client\": \"\",\n \"columns\": [\n {\n \"column\": {\n \"column\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_active\": \"\",\n \"rendering_type\": \"TAGS\"\n },\n \"id\": \"\",\n \"order\": \"\"\n },\n {\n \"column\": {\n \"column\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_active\": \"\",\n \"rendering_type\": \"DEFAULT\"\n },\n \"id\": \"\",\n \"order\": \"\"\n }\n ],\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"group_by\": \"TARGET\",\n \"column_ids\": [\n \"\",\n \"\"\n ],\n \"sort_by\": \"\",\n \"is_favorite\": \"\"\n }\n ]\n}"}],"_postman_id":"22be24f5-4fa4-4093-afa6-908a34225a6e"},{"name":"Get Saved Queries","id":"0be18732-f682-427e-9d2d-9377295f727b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/prioritize/saved-query?limit=&offset=","description":"

Retrieve a list of your Saved Queries that you created within the Prioritize Page or that were assigned to you\nby your Admin team

\n","urlObject":{"path":["prioritize","saved-query"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"4589d97b-3dd6-48e1-9a0a-3023494cf59d","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/prioritize/saved-query?limit=&offset=","host":["{{baseUrl}}"],"path":["prioritize","saved-query"],"query":[{"description":"Number of results to return per page.","key":"limit","value":""},{"description":"The initial index from which to return the results.","key":"offset","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"client\": \"\",\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"query\": {\n \"description\": \"Query Builder query\"\n },\n \"version\": \"\",\n \"is_favorite\": \"\"\n },\n {\n \"client\": \"\",\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"query\": {\n \"description\": \"Query Builder query\"\n },\n \"version\": \"\",\n \"is_favorite\": \"\"\n }\n ]\n}"}],"_postman_id":"0be18732-f682-427e-9d2d-9377295f727b"},{"name":"[Deprecated] Get Saved Reports","id":"ead9a72f-13de-4390-8e6e-1f252f4e7b76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/prioritize/saved-report?limit=&offset=","description":"

NOTE: Deprecated - This endpoint is no longer availble.

\n

Retrieve a list of your Saved Reports that you created within the Prioritize Page or that were assigned to you
by your Admin team. A report is the combination of a Query, Group By, and a Column Preset.

\n","urlObject":{"path":["prioritize","saved-report"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"8040a482-a355-4bc5-94ea-7b93f3ffa748","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/prioritize/saved-report?limit=&offset=","host":["{{baseUrl}}"],"path":["prioritize","saved-report"],"query":[{"description":"Number of results to return per page.","key":"limit","value":""},{"description":"The initial index from which to return the results.","key":"offset","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"client\": \"\",\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"saved_column_group_by\": {\n \"client\": \"\",\n \"columns\": [\n {\n \"column\": {\n \"column\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_active\": \"\",\n \"rendering_type\": \"TAGS\"\n },\n \"id\": \"\",\n \"order\": \"\"\n },\n {\n \"column\": {\n \"column\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_active\": \"\",\n \"rendering_type\": \"TAGS\"\n },\n \"id\": \"\",\n \"order\": \"\"\n }\n ],\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"group_by\": \"TARGET\",\n \"column_ids\": [\n \"\",\n \"\"\n ],\n \"sort_by\": \"\",\n \"is_favorite\": \"\"\n },\n \"saved_column_group_by_id\": \"\",\n \"saved_query\": {\n \"client\": \"\",\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"query\": {\n \"description\": \"Query Builder query\"\n },\n \"version\": \"\",\n \"is_favorite\": \"\"\n },\n \"saved_query_id\": \"\",\n \"group_by\": \"VULNERABILITY\",\n \"is_favorite\": \"\"\n },\n {\n \"client\": \"\",\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"saved_column_group_by\": {\n \"client\": \"\",\n \"columns\": [\n {\n \"column\": {\n \"column\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_active\": \"\",\n \"rendering_type\": \"DEFAULT\"\n },\n \"id\": \"\",\n \"order\": \"\"\n },\n {\n \"column\": {\n \"column\": \"\",\n \"display_name\": \"\",\n \"id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_active\": \"\",\n \"rendering_type\": \"DEFAULT\"\n },\n \"id\": \"\",\n \"order\": \"\"\n }\n ],\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"group_by\": \"TARGET\",\n \"column_ids\": [\n \"\",\n \"\"\n ],\n \"sort_by\": \"\",\n \"is_favorite\": \"\"\n },\n \"saved_column_group_by_id\": \"\",\n \"saved_query\": {\n \"client\": \"\",\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"owner\": \"\",\n \"query\": {\n \"description\": \"Query Builder query\"\n },\n \"version\": \"\",\n \"is_favorite\": \"\"\n },\n \"saved_query_id\": \"\",\n \"group_by\": \"TARGET\",\n \"is_favorite\": \"\"\n }\n ]\n}"}],"_postman_id":"ead9a72f-13de-4390-8e6e-1f252f4e7b76"}],"id":"49ba72c1-157e-47a7-b8c2-7c2b7ab0f363","_postman_id":"49ba72c1-157e-47a7-b8c2-7c2b7ab0f363","description":""},{"name":"Exception Plans","item":[{"name":"Get Exception Plans","id":"57acac38-e8f9-42cc-afa1-3737d75d10cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/exceptionplan?created_at=&creation_method=&limit=&offset=&ordering=&search=&status=","description":"

Exception Plan

\n","urlObject":{"path":["remediate","exceptionplan"],"host":["{{baseUrl}}"],"query":[{"key":"created_at","value":""},{"key":"creation_method","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Which field to use when ordering the results.

\n","type":"text/plain"},"key":"ordering","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"search","value":""},{"key":"status","value":""}],"variable":[]}},"response":[{"id":"b2d1cc9a-fdd6-494f-a089-c305a8e64fc6","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/remediate/exceptionplan?created_at=&creation_method=&limit=&offset=&ordering=&search=&status=","host":["{{baseUrl}}"],"path":["remediate","exceptionplan"],"query":[{"key":"created_at","value":""},{"key":"creation_method","value":""},{"description":"Number of results to return per page.","key":"limit","value":""},{"description":"The initial index from which to return the results.","key":"offset","value":""},{"description":"Which field to use when ordering the results.","key":"ordering","value":""},{"description":"A search term.","key":"search","value":""},{"key":"status","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"action_request_ids\": [],\n \"approval_date\": \"\",\n \"approver\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"+hA\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"created_at\": \"\",\n \"creation_method\": \"AUTO\",\n \"id\": \"\",\n \"plan_id\": \"\",\n \"reason\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"8aDdegxnpc-\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"updated_at\": \"\",\n \"approval_url\": \"\",\n \"approver_id\": \"\",\n \"exceptionplan_attachments\": [\n {\n \"exceptionplan_id\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"s3_path\": \"\"\n },\n {\n \"exceptionplan_id\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"s3_path\": \"\"\n }\n ],\n \"details\": \"\",\n \"status\": \"EXPIRED\",\n \"type\": \"RISK_MITIGATED\",\n \"expiration_date\": \"\",\n \"vuln_instance_ids\": [\n \"\",\n \"\"\n ],\n \"query_data\": {\n \"grouping\": \"VULN_INSTANCE\",\n \"query\": {\n \"description\": \"Either query or selected ids must be provided. If no query is provided, all vuln instances for selected ids will be included.\"\n },\n \"selected_ids\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"action_request_ids\": [],\n \"approval_date\": \"\",\n \"approver\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"Eph55\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"created_at\": \"\",\n \"creation_method\": \"THIRD_PARTY_INGEST\",\n \"id\": \"\",\n \"plan_id\": \"\",\n \"reason\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"iJ-AK6GI\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"updated_at\": \"\",\n \"approval_url\": \"\",\n \"approver_id\": \"\",\n \"exceptionplan_attachments\": [\n {\n \"exceptionplan_id\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"s3_path\": \"\"\n },\n {\n \"exceptionplan_id\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"s3_path\": \"\"\n }\n ],\n \"details\": \"\",\n \"status\": \"SUBMITTED\",\n \"type\": \"FALSE_POSITIVE\",\n \"expiration_date\": \"\",\n \"vuln_instance_ids\": [\n \"\",\n \"\"\n ],\n \"query_data\": {\n \"grouping\": \"VULN_INSTANCE\",\n \"query\": {\n \"description\": \"Either query or selected ids must be provided. If no query is provided, all vuln instances for selected ids will be included.\"\n },\n \"selected_ids\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}"}],"_postman_id":"57acac38-e8f9-42cc-afa1-3737d75d10cb"},{"name":"Create Exception Plan","id":"1bedd99c-7253-4d10-a41c-a373d079bd18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

(Required)

\n","key":"id","value":""},{"description":"

(Required)

\n","key":"reason","value":""},{"key":"approval_url","value":""},{"key":"exceptionplan_attachments","value":"[object Object]"},{"key":"exceptionplan_attachments","value":"[object Object]"},{"key":"details","value":""},{"description":"
    \n
  • FALSE_POSITIVE - False Positive
    • \n
  • RISK_ACCEPTED - Risk Accepted
    • \n
  • RISK_MITIGATED - Risk Mitigated
    • \n
  • NONE - None
    • \n
\n","key":"type","value":"FALSE_POSITIVE"},{"key":"expiration_date","value":""},{"description":"

Must pass either vuln instance ids or query_data field. If vuln_instance_ids are passed they will be used over query_data.

\n","key":"vuln_instance_ids","value":""},{"description":"

Must pass either vuln instance ids or query_data field. If vuln_instance_ids are passed they will be used over query_data.

\n","key":"vuln_instance_ids","value":""},{"key":"grouping","value":"VULN_INSTANCE"},{"key":"query","value":"[object Object]"},{"key":"selected_ids","value":","}]},"url":"{{baseUrl}}/remediate/exceptionplan?created_at=&creation_method=&status=","description":"

Exception Plan

\n","urlObject":{"path":["remediate","exceptionplan"],"host":["{{baseUrl}}"],"query":[{"key":"created_at","value":""},{"key":"creation_method","value":""},{"key":"status","value":""}],"variable":[]}},"response":[{"id":"b88235aa-e4ff-44f7-89d2-1eadafcea886","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) ","key":"id","value":""},{"description":"(Required) ","key":"reason","value":""},{"key":"approval_url","value":""},{"key":"exceptionplan_attachments","value":"[object Object]"},{"key":"exceptionplan_attachments","value":"[object Object]"},{"key":"details","value":""},{"description":"* `FALSE_POSITIVE` - False Positive\n* `RISK_ACCEPTED` - Risk Accepted\n* `RISK_MITIGATED` - Risk Mitigated\n* `NONE` - None","key":"type","value":"FALSE_POSITIVE"},{"key":"expiration_date","value":""},{"description":"Must pass either vuln instance ids or query_data field. If vuln_instance_ids are passed they will be used over query_data.","key":"vuln_instance_ids","value":""},{"description":"Must pass either vuln instance ids or query_data field. If vuln_instance_ids are passed they will be used over query_data.","key":"vuln_instance_ids","value":""},{"key":"grouping","value":"VULN_INSTANCE"},{"key":"query","value":"[object Object]"},{"key":"selected_ids","value":","}]},"url":{"raw":"{{baseUrl}}/remediate/exceptionplan?created_at=&creation_method=&status=","host":["{{baseUrl}}"],"path":["remediate","exceptionplan"],"query":[{"key":"created_at","value":""},{"key":"creation_method","value":""},{"key":"status","value":""}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"action_request_ids\": [],\n \"id\": \"\",\n \"reason\": \"\",\n \"approval_url\": \"\",\n \"exceptionplan_attachments\": [\n {\n \"exceptionplan_id\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"s3_path\": \"\"\n },\n {\n \"exceptionplan_id\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"s3_path\": \"\"\n }\n ],\n \"details\": \"\",\n \"type\": \"FALSE_POSITIVE\",\n \"expiration_date\": \"\",\n \"vuln_instance_ids\": [\n \"\",\n \"\"\n ],\n \"query_data\": {\n \"grouping\": \"VULN_INSTANCE\",\n \"query\": {\n \"description\": \"Either query or selected ids must be provided. If no query is provided, all vuln instances for selected ids will be included.\"\n },\n \"selected_ids\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"1bedd99c-7253-4d10-a41c-a373d079bd18"},{"name":"Get Exception Plan Details","id":"f6d22e84-a31f-45ac-ab59-f4f16896acac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/exceptionplan/:id","description":"

Get a specific Exception Plan’s details by ID.

\n","urlObject":{"path":["remediate","exceptionplan",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"92178bf3-a19e-4382-9edc-3fe99c205cf8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e2e0b754-fe0a-4479-8212-c172f9b5a6c3","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/remediate/exceptionplan/:id","host":["{{baseUrl}}"],"path":["remediate","exceptionplan",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"action_request_ids\": [],\n \"approval_date\": \"\",\n \"approver\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"QkRA@h9FvcX\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"created_at\": \"\",\n \"creation_method\": \"AUTO\",\n \"id\": \"\",\n \"plan_id\": \"\",\n \"reason\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"kTG.z7JXrr\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"updated_at\": \"\",\n \"approval_url\": \"\",\n \"approver_id\": \"\",\n \"exceptionplan_attachments\": [\n {\n \"exceptionplan_id\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"s3_path\": \"\"\n },\n {\n \"exceptionplan_id\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"s3_path\": \"\"\n }\n ],\n \"details\": \"\",\n \"status\": \"CANCELLED\",\n \"type\": \"FALSE_POSITIVE\",\n \"expiration_date\": \"\",\n \"vuln_instance_ids\": [\n \"\",\n \"\"\n ],\n \"query_data\": {\n \"grouping\": \"TARGET\",\n \"query\": {\n \"description\": \"Either query or selected ids must be provided. If no query is provided, all vuln instances for selected ids will be included.\"\n },\n \"selected_ids\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"f6d22e84-a31f-45ac-ab59-f4f16896acac"},{"name":"Get Exception Plan Vuln Instances","id":"5dc09978-50f4-4ace-95d6-41a3cc354227","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/exceptionplan/:plan_id/vuln_instance?limit=&offset=","description":"

Retrieve the specific vuln instance IDs and details for a specific Exception Plan.

\n","urlObject":{"path":["remediate","exceptionplan",":plan_id","vuln_instance"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[{"id":"c4141d5e-ed54-40a3-bc79-9fcaaf6a78f1","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"plan_id"}]}},"response":[{"id":"5011c568-71d0-4821-b09e-9c51efc735a2","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-NOPSEC-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"{{baseUrl}}/remediate/exceptionplan/:plan_id/vuln_instance?limit=&offset=","host":["{{baseUrl}}"],"path":["remediate","exceptionplan",":plan_id","vuln_instance"],"query":[{"key":"limit","value":"","description":"Number of results to return per page."},{"key":"offset","value":"","description":"The initial index from which to return the results."}],"variable":[{"key":"plan_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"derived_target_criticality\": \"HIGH\",\n \"derived_target_division\": \"\",\n \"derived_target_risk_grade\": \"\",\n \"derived_target_risk_score\": \"\",\n \"derived_vuln_cve_list\": [\n \"\",\n \"\"\n ],\n \"derived_vuln_risk_grade\": \"\",\n \"derived_vuln_risk_score\": \"\",\n \"exceptionplan_status\": \"\",\n \"first_detected_date\": \"\",\n \"id\": \"\",\n \"remediation_date\": \"\",\n \"status\": \"\",\n \"target_id\": \"\",\n \"target_location\": \"\",\n \"target_name\": \"\",\n \"target_type\": \"\",\n \"vuln_cves\": [],\n \"vuln_cwes\": [],\n \"vuln_description\": \"\",\n \"vuln_id\": \"\",\n \"vuln_max_cvssv3\": \"\",\n \"vuln_title\": \"\"\n },\n {\n \"derived_target_criticality\": \"CRITICAL\",\n \"derived_target_division\": \"\",\n \"derived_target_risk_grade\": \"\",\n \"derived_target_risk_score\": \"\",\n \"derived_vuln_cve_list\": [\n \"\",\n \"\"\n ],\n \"derived_vuln_risk_grade\": \"\",\n \"derived_vuln_risk_score\": \"\",\n \"exceptionplan_status\": \"\",\n \"first_detected_date\": \"\",\n \"id\": \"\",\n \"remediation_date\": \"\",\n \"status\": \"\",\n \"target_id\": \"\",\n \"target_location\": \"\",\n \"target_name\": \"\",\n \"target_type\": \"\",\n \"vuln_cves\": [],\n \"vuln_cwes\": [],\n \"vuln_description\": \"\",\n \"vuln_id\": \"\",\n \"vuln_max_cvssv3\": \"\",\n \"vuln_title\": \"\"\n }\n ]\n}"}],"_postman_id":"5dc09978-50f4-4ace-95d6-41a3cc354227"},{"name":"Get Reasons for Exception Plans","id":"e835b903-d57a-46ba-af52-20330973e5af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/exceptionplan/client-setting","description":"

In order to create an Exception Plan a Reason is required. Reasons are configured and managed by your Admin\nteam. Use this API to get a list of all available Reasons and use the string in your 'Create Exception Plan'\nrequest.

\n","urlObject":{"path":["remediate","exceptionplan","client-setting"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"50bf2c41-cd32-4af8-9799-8cde863faf63","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":"{{baseUrl}}/remediate/exceptionplan/client-setting"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"exceptionplan_reasons\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"e835b903-d57a-46ba-af52-20330973e5af"}],"id":"bc9199e3-fd28-4e2f-bdd4-3d203cfdf530","_postman_id":"bc9199e3-fd28-4e2f-bdd4-3d203cfdf530","description":""},{"name":"Remediation Actions","item":[{"name":"Get ITSM Destination Setting Detail","id":"0b72045f-1c7b-4dc1-a167-add11e2c7cbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/itsm/:group_by/destination?limit=&offset=","description":"

Available Active ITSM Destination Setting List for the \"Group By\" Option

\n","urlObject":{"path":["remediate","itsm",":group_by","destination"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[{"id":"2861a62e-51b8-4022-99e2-4d87b9e79e4e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"group_by"}]}},"response":[{"id":"865843b8-1844-449e-9532-31f3b3392706","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/remediate/itsm/:group_by/destination?limit=&offset=","host":["{{baseUrl}}"],"path":["remediate","itsm",":group_by","destination"],"query":[{"description":"Number of results to return per page.","key":"limit","value":""},{"description":"The initial index from which to return the results.","key":"offset","value":""}],"variable":[{"key":"group_by"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"group_by\": \"TARGET\",\n \"id\": \"\",\n \"itsm_destination\": {\n \"destination\": \"\",\n \"id\": \"\",\n \"itsm_integration_name\": \"\",\n \"itsm_product_logo\": \"\",\n \"itsm_product_name\": \"\",\n \"name\": \"\",\n \"is_active\": \"\"\n },\n \"is_active\": \"\"\n },\n {\n \"group_by\": \"VULN\",\n \"id\": \"\",\n \"itsm_destination\": {\n \"destination\": \"\",\n \"id\": \"\",\n \"itsm_integration_name\": \"\",\n \"itsm_product_logo\": \"\",\n \"itsm_product_name\": \"\",\n \"name\": \"\",\n \"is_active\": \"\"\n },\n \"is_active\": \"\"\n }\n ]\n}"}],"_postman_id":"0b72045f-1c7b-4dc1-a167-add11e2c7cbe"},{"name":"Get Remediation Actions","id":"28de98de-7596-4a74-841a-8274a76f23e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/remediationplan/action?created_at=&creation_method=&due_date=&is_canceled=&limit=&offset=&ordering=&search=&team_id=","description":"

Get a list of all remediation actions that you have access to based on your permissions. Remediation Actions\nmay hold one or more Remediation Plans within it depending on the Group By used to create the Action.\nEach Plan can track one or more Vuln Instances. Using the Remediation Action ID you can view the specific Action\ndetails by calling the ‘Get Remediation Action Details’ API or you can get a list of all Plans created by this\nAction using the 'Get Plans in Remediation Action' API.

\n","urlObject":{"path":["remediate","remediationplan","action"],"host":["{{baseUrl}}"],"query":[{"key":"created_at","value":""},{"key":"creation_method","value":""},{"key":"due_date","value":""},{"key":"is_canceled","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Which field to use when ordering the results.

\n","type":"text/plain"},"key":"ordering","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"search","value":""},{"key":"team_id","value":""}],"variable":[]}},"response":[{"id":"f0a194ef-f192-470c-8169-ae9cc095a7d1","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/remediate/remediationplan/action?created_at=&creation_method=&due_date=&is_canceled=&limit=&offset=&ordering=&search=&team_id=","host":["{{baseUrl}}"],"path":["remediate","remediationplan","action"],"query":[{"key":"created_at","value":""},{"key":"creation_method","value":""},{"key":"due_date","value":""},{"key":"is_canceled","value":""},{"description":"Number of results to return per page.","key":"limit","value":""},{"description":"The initial index from which to return the results.","key":"offset","value":""},{"description":"Which field to use when ordering the results.","key":"ordering","value":""},{"description":"A search term.","key":"search","value":""},{"key":"team_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"action_id\": \"\",\n \"action_request_ids\": [],\n \"created_at\": \"\",\n \"group_by\": \"TARGET\",\n \"id\": \"\",\n \"itsm_destination\": {\n \"destination\": \"\",\n \"id\": \"\",\n \"itsm_integration_name\": \"\",\n \"itsm_product_logo\": \"\",\n \"itsm_product_name\": \"\",\n \"name\": \"\",\n \"is_active\": \"\"\n },\n \"name\": \"\",\n \"remediated_vuln_instances_count\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"v9N_xff\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"total_plans_count\": \"\",\n \"total_vuln_instances_count\": \"\",\n \"updated_at\": \"\",\n \"is_canceled\": \"\",\n \"creation_method\": \"AUTO\",\n \"created_by\": \"\",\n \"vuln_instance_ids\": [\n \"\",\n \"\"\n ],\n \"query_data\": {\n \"grouping\": \"VULN_INSTANCE\",\n \"query\": {\n \"description\": \"Either query or selected ids must be provided. If no query is provided, all vuln instances for selected ids will be included.\"\n },\n \"selected_ids\": [\n \"\",\n \"\"\n ]\n },\n \"itsm_destination_id\": \"\",\n \"due_date\": \"\",\n \"details\": \"\",\n \"max_number_created\": \"\"\n },\n {\n \"action_id\": \"\",\n \"action_request_ids\": [],\n \"created_at\": \"\",\n \"group_by\": \"NO_GROUP\",\n \"id\": \"\",\n \"itsm_destination\": {\n \"destination\": \"\",\n \"id\": \"\",\n \"itsm_integration_name\": \"\",\n \"itsm_product_logo\": \"\",\n \"itsm_product_name\": \"\",\n \"name\": \"\",\n \"is_active\": \"\"\n },\n \"name\": \"\",\n \"remediated_vuln_instances_count\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"-LC+Rl0bog\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"total_plans_count\": \"\",\n \"total_vuln_instances_count\": \"\",\n \"updated_at\": \"\",\n \"is_canceled\": \"\",\n \"creation_method\": \"AUTO\",\n \"created_by\": \"\",\n \"vuln_instance_ids\": [\n \"\",\n \"\"\n ],\n \"query_data\": {\n \"grouping\": \"VULNERABILITY\",\n \"query\": {\n \"description\": \"Either query or selected ids must be provided. If no query is provided, all vuln instances for selected ids will be included.\"\n },\n \"selected_ids\": [\n \"\",\n \"\"\n ]\n },\n \"itsm_destination_id\": \"\",\n \"due_date\": \"\",\n \"details\": \"\",\n \"max_number_created\": \"\"\n }\n ]\n}"}],"_postman_id":"28de98de-7596-4a74-841a-8274a76f23e2"},{"name":"Create Remediation Action","id":"fa15e3ee-6fbb-434f-ab47-23915dc8fedd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

(Required)

\n","key":"group_by","value":"TARGET"},{"description":"

(Required)

\n","key":"id","value":""},{"description":"

(Required)

\n","key":"name","value":""},{"key":"vuln_instance_ids","value":""},{"key":"vuln_instance_ids","value":""},{"key":"grouping","value":"VULNERABILITY"},{"key":"query","value":"[object Object]"},{"key":"selected_ids","value":","},{"key":"itsm_destination_id","value":""},{"key":"due_date","value":""},{"key":"details","value":""},{"key":"max_number_created","value":""}]},"url":"{{baseUrl}}/remediate/remediationplan/action","description":"

Create a remediation action by providing a query ID or a list of vuln instance IDs, an Action Name,\na Group By selection, and a Destination. By Default, a Local Only destination is set if no destination is\nprovided. Depending on your Group By Setting there may be one or more Plans created. You can think of Plans as\nthe Tickets or Emails that would be sent to your ITSM if you selected a Destination other than Local Only.

\n","urlObject":{"path":["remediate","remediationplan","action"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"526f4153-91f4-4d78-8b5a-577fb962c360","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) ","key":"group_by","value":"TARGET"},{"description":"(Required) ","key":"id","value":""},{"description":"(Required) ","key":"name","value":""},{"key":"vuln_instance_ids","value":""},{"key":"vuln_instance_ids","value":""},{"key":"grouping","value":"VULNERABILITY"},{"key":"query","value":"[object Object]"},{"key":"selected_ids","value":","},{"key":"itsm_destination_id","value":""},{"key":"due_date","value":""},{"key":"details","value":""},{"key":"max_number_created","value":""}]},"url":"{{baseUrl}}/remediate/remediationplan/action"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"action_request_ids\": [],\n \"group_by\": \"TARGET\",\n \"id\": \"\",\n \"name\": \"\",\n \"vuln_instance_ids\": [\n \"\",\n \"\"\n ],\n \"query_data\": {\n \"grouping\": \"VULNERABILITY\",\n \"query\": {\n \"description\": \"Either query or selected ids must be provided. If no query is provided, all vuln instances for selected ids will be included.\"\n },\n \"selected_ids\": [\n \"\",\n \"\"\n ]\n },\n \"itsm_destination_id\": \"\",\n \"due_date\": \"\",\n \"details\": \"\",\n \"max_number_created\": \"\"\n}"}],"_postman_id":"fa15e3ee-6fbb-434f-ab47-23915dc8fedd"},{"name":"Get Plans in Remediation Action","id":"c34aabc7-43a6-4b1a-bb8b-e73989bfeba0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/remediationplan/action/:action_id/plan?limit=&offset=&ordering=&search=","description":"

Each Remediation Action may create one or more Plans depending on the Group By selected during creation of the\nAction. Use this API to retrieve the list of Plan IDs created by a specific Action. so, you can download\nspecific Plans details or Vuln Instances

\n","urlObject":{"path":["remediate","remediationplan","action",":action_id","plan"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Which field to use when ordering the results.

\n","type":"text/plain"},"key":"ordering","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"search","value":""}],"variable":[{"id":"96832197-18e7-43a3-8090-9af16c3f928e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"action_id"}]}},"response":[{"id":"0fe3e37f-b2e3-49b9-a8b3-8027278c4c67","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/remediate/remediationplan/action/:action_id/plan?limit=&offset=&ordering=&search=","host":["{{baseUrl}}"],"path":["remediate","remediationplan","action",":action_id","plan"],"query":[{"description":"Number of results to return per page.","key":"limit","value":""},{"description":"The initial index from which to return the results.","key":"offset","value":""},{"description":"Which field to use when ordering the results.","key":"ordering","value":""},{"description":"A search term.","key":"search","value":""}],"variable":[{"key":"action_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"action_request_ids\": [],\n \"created_at\": \"\",\n \"creation_method\": \"\",\n \"derived_vuln_instance_info\": {\n \"derived_target_criticality\": \"LOW\",\n \"derived_target_risk_grade\": \"\",\n \"derived_target_risk_score\": \"\",\n \"derived_vuln_cve_list\": [\n \"\",\n \"\"\n ],\n \"derived_vuln_risk_grade\": \"\",\n \"derived_vuln_risk_score\": \"\",\n \"exceptionplan_status\": \"\",\n \"first_detected_date\": \"\",\n \"id\": \"\",\n \"remediation_date\": \"\",\n \"status\": \"\",\n \"target_id\": \"\",\n \"target_location\": \"\",\n \"target_name\": \"\",\n \"target_type\": \"\",\n \"vuln_description\": \"\",\n \"vuln_id\": \"\",\n \"vuln_max_cvssv3\": \"\",\n \"vuln_title\": \"\"\n },\n \"details\": \"\",\n \"due_date\": \"\",\n \"group_by\": \"\",\n \"id\": \"\",\n \"itsmticket\": {\n \"destination_users\": [\n {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"Fh\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"LOPUmNW@\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n }\n ],\n \"ext_url\": \"\",\n \"group_by\": \"NO_GROUP\",\n \"id\": \"\",\n \"itsm_destination\": {\n \"destination\": \"\",\n \"id\": \"\",\n \"itsm_integration_name\": \"\",\n \"itsm_product_logo\": \"\",\n \"itsm_product_name\": \"\",\n \"name\": \"\",\n \"is_active\": \"\"\n },\n \"remediation_plan_id\": \"\",\n \"internal_status\": \"\",\n \"ext_id\": \"\",\n \"ext_number\": \"\",\n \"ext_status\": \"\",\n \"ext_assignee\": \"\",\n \"destination_ext_email_list\": [\n \"\",\n \"\"\n ]\n },\n \"plan_id\": \"\",\n \"remediated_vuln_instances_count\": \"\",\n \"remediation_action_id\": \"\",\n \"status\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"_Z6BOVtjK\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"total_vuln_instances_count\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"action_request_ids\": [],\n \"created_at\": \"\",\n \"creation_method\": \"\",\n \"derived_vuln_instance_info\": {\n \"derived_target_criticality\": \"NONE\",\n \"derived_target_risk_grade\": \"\",\n \"derived_target_risk_score\": \"\",\n \"derived_vuln_cve_list\": [\n \"\",\n \"\"\n ],\n \"derived_vuln_risk_grade\": \"\",\n \"derived_vuln_risk_score\": \"\",\n \"exceptionplan_status\": \"\",\n \"first_detected_date\": \"\",\n \"id\": \"\",\n \"remediation_date\": \"\",\n \"status\": \"\",\n \"target_id\": \"\",\n \"target_location\": \"\",\n \"target_name\": \"\",\n \"target_type\": \"\",\n \"vuln_description\": \"\",\n \"vuln_id\": \"\",\n \"vuln_max_cvssv3\": \"\",\n \"vuln_title\": \"\"\n },\n \"details\": \"\",\n \"due_date\": \"\",\n \"group_by\": \"\",\n \"id\": \"\",\n \"itsmticket\": {\n \"destination_users\": [\n {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"GSsZo0Z\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"ya.rQkMG@V4\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n }\n ],\n \"ext_url\": \"\",\n \"group_by\": \"VULN_INSTANCE\",\n \"id\": \"\",\n \"itsm_destination\": {\n \"destination\": \"\",\n \"id\": \"\",\n \"itsm_integration_name\": \"\",\n \"itsm_product_logo\": \"\",\n \"itsm_product_name\": \"\",\n \"name\": \"\",\n \"is_active\": \"\"\n },\n \"remediation_plan_id\": \"\",\n \"internal_status\": \"\",\n \"ext_id\": \"\",\n \"ext_number\": \"\",\n \"ext_status\": \"\",\n \"ext_assignee\": \"\",\n \"destination_ext_email_list\": [\n \"\",\n \"\"\n ]\n },\n \"plan_id\": \"\",\n \"remediated_vuln_instances_count\": \"\",\n \"remediation_action_id\": \"\",\n \"status\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"2.U_Iopu5Q5\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"total_vuln_instances_count\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}"}],"_postman_id":"c34aabc7-43a6-4b1a-bb8b-e73989bfeba0"},{"name":"Get Plan Details","id":"10c17e09-8dca-49ae-8542-f145a86b944b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/remediationplan/action/:action_id/plan/:id","description":"

Use a specific Action ID and Remediation Plan ID to retrieve the Plan level details such as the number of vuln\ninstances, its destination, or its progress. To download the Vuln Instances call the 'Get Vuln Instances within\nPlan' API.

\n","urlObject":{"path":["remediate","remediationplan","action",":action_id","plan",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"8667f492-c38d-4985-b5ae-1bd8676eea9a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"action_id"},{"id":"ea28ad2f-b40d-4793-8501-5e10c8d1f366","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"eeb15d2f-0ba8-4530-9cf3-c2e10a42c0a1","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/remediate/remediationplan/action/:action_id/plan/:id","host":["{{baseUrl}}"],"path":["remediate","remediationplan","action",":action_id","plan",":id"],"variable":[{"key":"action_id"},{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"action_request_ids\": [],\n \"created_at\": \"\",\n \"creation_method\": \"\",\n \"derived_vuln_instance_info\": {\n \"derived_target_criticality\": \"NONE\",\n \"derived_target_risk_grade\": \"\",\n \"derived_target_risk_score\": \"\",\n \"derived_vuln_cve_list\": [\n \"\",\n \"\"\n ],\n \"derived_vuln_risk_grade\": \"\",\n \"derived_vuln_risk_score\": \"\",\n \"exceptionplan_status\": \"\",\n \"first_detected_date\": \"\",\n \"id\": \"\",\n \"remediation_date\": \"\",\n \"status\": \"\",\n \"target_id\": \"\",\n \"target_location\": \"\",\n \"target_name\": \"\",\n \"target_type\": \"\",\n \"vuln_description\": \"\",\n \"vuln_id\": \"\",\n \"vuln_max_cvssv3\": \"\",\n \"vuln_title\": \"\"\n },\n \"details\": \"\",\n \"due_date\": \"\",\n \"group_by\": \"\",\n \"id\": \"\",\n \"itsmticket\": {\n \"destination_users\": [\n {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"UQu+\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"bHmtHHe\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n }\n ],\n \"ext_url\": \"\",\n \"group_by\": \"VULN_INSTANCE\",\n \"id\": \"\",\n \"itsm_destination\": {\n \"destination\": \"\",\n \"id\": \"\",\n \"itsm_integration_name\": \"\",\n \"itsm_product_logo\": \"\",\n \"itsm_product_name\": \"\",\n \"name\": \"\",\n \"is_active\": \"\"\n },\n \"remediation_plan_id\": \"\",\n \"internal_status\": \"\",\n \"ext_id\": \"\",\n \"ext_number\": \"\",\n \"ext_status\": \"\",\n \"ext_assignee\": \"\",\n \"destination_ext_email_list\": [\n \"\",\n \"\"\n ]\n },\n \"plan_id\": \"\",\n \"remediated_vuln_instances_count\": \"\",\n \"remediation_action_id\": \"\",\n \"status\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \".P\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"total_vuln_instances_count\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"10c17e09-8dca-49ae-8542-f145a86b944b"},{"name":"Get Vuln Instances within Plan","id":"fb8bccd4-bf51-4748-a55d-7d45f0655e9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/remediationplan/action/:action_id/plan/:plan_id/vuln_instance?limit=&offset=","description":"

Use this API to retrieve a list of Vuln Instance IDs and details for a specific Remediation Plan.

\n","urlObject":{"path":["remediate","remediationplan","action",":action_id","plan",":plan_id","vuln_instance"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[{"id":"c2dd39b5-351d-465c-9c3d-6df55f4d86e6","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"action_id"},{"id":"7aef64ce-9a4a-4e5d-b77e-f6d29d44239f","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"plan_id"}]}},"response":[{"id":"ebe9ac23-fa90-488c-87da-ffd07184a3a3","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-NOPSEC-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"{{baseUrl}}/remediate/remediationplan/action/:action_id/plan/:plan_id/vuln_instance?limit=&offset=","host":["{{baseUrl}}"],"path":["remediate","remediationplan","action",":action_id","plan",":plan_id","vuln_instance"],"query":[{"key":"limit","value":"","description":"Number of results to return per page."},{"key":"offset","value":"","description":"The initial index from which to return the results."}],"variable":[{"key":"action_id","value":""},{"key":"plan_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"derived_target_criticality\": \"HIGH\",\n \"derived_target_division\": \"\",\n \"derived_target_risk_grade\": \"\",\n \"derived_target_risk_score\": \"\",\n \"derived_vuln_cve_list\": [\n \"\",\n \"\"\n ],\n \"derived_vuln_risk_grade\": \"\",\n \"derived_vuln_risk_score\": \"\",\n \"exceptionplan_status\": \"\",\n \"first_detected_date\": \"\",\n \"id\": \"\",\n \"remediation_date\": \"\",\n \"status\": \"\",\n \"target_id\": \"\",\n \"target_location\": \"\",\n \"target_name\": \"\",\n \"target_type\": \"\",\n \"vuln_cves\": [],\n \"vuln_cwes\": [],\n \"vuln_description\": \"\",\n \"vuln_id\": \"\",\n \"vuln_max_cvssv3\": \"\",\n \"vuln_title\": \"\"\n },\n {\n \"derived_target_criticality\": \"CRITICAL\",\n \"derived_target_division\": \"\",\n \"derived_target_risk_grade\": \"\",\n \"derived_target_risk_score\": \"\",\n \"derived_vuln_cve_list\": [\n \"\",\n \"\"\n ],\n \"derived_vuln_risk_grade\": \"\",\n \"derived_vuln_risk_score\": \"\",\n \"exceptionplan_status\": \"\",\n \"first_detected_date\": \"\",\n \"id\": \"\",\n \"remediation_date\": \"\",\n \"status\": \"\",\n \"target_id\": \"\",\n \"target_location\": \"\",\n \"target_name\": \"\",\n \"target_type\": \"\",\n \"vuln_cves\": [],\n \"vuln_cwes\": [],\n \"vuln_description\": \"\",\n \"vuln_id\": \"\",\n \"vuln_max_cvssv3\": \"\",\n \"vuln_title\": \"\"\n }\n ]\n}"}],"_postman_id":"fb8bccd4-bf51-4748-a55d-7d45f0655e9c"},{"name":"Get Remediation Action Details","id":"bedd9321-01ff-4bbb-b60b-57e7d094e07f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/remediate/remediationplan/action/:id","description":"

Each Remediation Action holds metadata such as the creator of the Action, the number of Plans created, their\ncurrent status, the Description provided by the user, and other fields.

\n","urlObject":{"path":["remediate","remediationplan","action",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"6363c4e8-80a2-4934-829c-c4f00cceae8d","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e458142d-a8ad-46ac-be1f-b76f9016e883","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/remediate/remediationplan/action/:id","host":["{{baseUrl}}"],"path":["remediate","remediationplan","action",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"action_id\": \"\",\n \"action_request_ids\": [],\n \"created_at\": \"\",\n \"group_by\": \"TARGET\",\n \"id\": \"\",\n \"itsm_destination\": {\n \"destination\": \"\",\n \"id\": \"\",\n \"itsm_integration_name\": \"\",\n \"itsm_product_logo\": \"\",\n \"itsm_product_name\": \"\",\n \"name\": \"\",\n \"is_active\": \"\"\n },\n \"name\": \"\",\n \"remediated_vuln_instances_count\": \"\",\n \"submitter\": {\n \"email\": \"\",\n \"full_name\": \"\",\n \"username\": \"fJtB0E5\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"department\": \"\",\n \"job_title\": \"\",\n \"is_active\": \"\"\n },\n \"total_plans_count\": \"\",\n \"total_vuln_instances_count\": \"\",\n \"updated_at\": \"\",\n \"is_canceled\": \"\",\n \"creation_method\": \"MANUAL\",\n \"created_by\": \"\",\n \"vuln_instance_ids\": [\n \"\",\n \"\"\n ],\n \"query_data\": {\n \"grouping\": \"VULN_INSTANCE\",\n \"query\": {\n \"description\": \"Either query or selected ids must be provided. If no query is provided, all vuln instances for selected ids will be included.\"\n },\n \"selected_ids\": [\n \"\",\n \"\"\n ]\n },\n \"itsm_destination_id\": \"\",\n \"due_date\": \"\",\n \"details\": \"\",\n \"max_number_created\": \"\"\n}"}],"_postman_id":"bedd9321-01ff-4bbb-b60b-57e7d094e07f"}],"id":"44c4227b-39da-45f9-a0a3-f24eb495687d","_postman_id":"44c4227b-39da-45f9-a0a3-f24eb495687d","description":""},{"name":"Reports","item":[{"name":"Create Download Task","id":"e8979fec-96a7-4e54-ad13-95d229c590e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

(Required)

\n
    \n
  • TARGET - Target
    • \n
  • VULN_INSTANCE - Vuln Instance
    • \n
  • VULNERABILITY - Vulnerability
    • \n
\n","key":"group_by","value":"VULNERABILITY"},{"key":"sort_by","value":""},{"key":"query","value":"[object Object]"},{"description":"

(Required)

\n","key":"saved_report_id","value":""},{"key":"saved_query_id","value":""},{"key":"saved_column_group_by_id","value":""},{"key":"data_fields","value":","},{"key":"agg_fields","value":","},{"key":"ids","value":","},{"key":"max_download_limit","value":""},{"key":"limit","value":""},{"key":"offset","value":""},{"description":"

Download Request Id.

\n","key":"download_request_id","value":""},{"description":"

List of file attachment ids

\n","key":"file_attachment_ids","value":""},{"key":"id","value":""},{"description":"

Array of urls to download

\n","key":"urls","value":""},{"description":"
    \n
  • REQUESTED - Requested
    • \n
  • IN_PROGRESS - In Progress
    • \n
  • COMPLETED - Completed
    • \n
  • ERROR - Error
    • \n
\n","key":"status","value":"ERROR"}]},"url":"{{baseUrl}}/search/download-csv-sql","description":"

You can download an existing saved Report as a CSV file by first 'Creating a Download Task'. You will be given
a Task ID which you can check the status of by calling the 'Download Status' API. Once the task is 'Completed'
you will be given a list of one or more File IDs which you can download by using the 'Download CSV File' API.
This process is needed to enable the large export of data which may be attempting to download millions of
records from our database. Each file will hold 1 million rows. Each file will leverage the Columns dictated by
the Column Preset saved for that report.

\n","urlObject":{"path":["search","download-csv-sql"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"90f25339-7137-402f-a76d-b8c7a64e8a7c","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) ","key":"group_by","value":"VULNERABILITY"},{"description":"(Required) ","key":"sort_by","value":""},{"description":"(Required) ","key":"query","value":"[object Object]"},{"description":"(Required) ","key":"saved_report_id","value":""},{"description":"(Required) ","key":"saved_query_id","value":""},{"description":"(Required) ","key":"saved_column_group_by_id","value":""},{"description":"(Required) ","key":"data_fields","value":","},{"description":"(Required) ","key":"agg_fields","value":","},{"description":"(Required) ","key":"ids","value":","},{"description":"(Required) ","key":"max_download_limit","value":""},{"description":"(Required) ","key":"limit","value":""},{"description":"(Required) ","key":"offset","value":""},{"description":"(Required) Download Request Id.","key":"download_request_id","value":""},{"description":"(Required) List of file attachment ids","key":"file_attachment_ids","value":""},{"description":"(Required) ","key":"id","value":""},{"description":"(Required) Array of urls to download","key":"urls","value":""},{"description":"* `REQUESTED` - Requested\n* `IN_PROGRESS` - In Progress\n* `COMPLETED` - Completed\n* `ERROR` - Error","key":"status","value":"ERROR"}]},"url":"{{baseUrl}}/search/download-csv"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"download_query\": {\n \"group_by\": \"VULNERABILITY\",\n \"sort_by\": \"\",\n \"query\": {},\n \"saved_report_id\": \"\",\n \"saved_query_id\": \"\",\n \"saved_column_group_by_id\": \"\",\n \"data_fields\": [\n \"\",\n \"\"\n ],\n \"agg_fields\": [\n \"\",\n \"\"\n ],\n \"ids\": [\n \"\",\n \"\"\n ],\n \"max_download_limit\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n },\n \"download_request_id\": \"\",\n \"file_attachment_ids\": \"\",\n \"id\": \"\",\n \"urls\": \"\",\n \"status\": \"ERROR\"\n}"}],"_postman_id":"e8979fec-96a7-4e54-ad13-95d229c590e3"},{"name":"Download CSV File","id":"bb9f6ee1-63b4-4651-9fa1-1b850f2622d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"text/csv"}],"url":"{{baseUrl}}/search/download-csv/:download_request_id/:id","description":"

Each Download Task may generate one or more files depending on the number of records in your report. Each file will leverage the Columns dictated by the Column Preset saved for that report. The output is CSV file using a common as the separator.

\n","urlObject":{"path":["search","download-csv",":download_request_id",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"","type":"text/plain"},"type":"any","value":"","key":"download_request_id"},{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0e3731ee-aaae-44b6-8b8b-1c79b4fc66c6","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/csv"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/search/download-csv/:download_request_id/:id","host":["{{baseUrl}}"],"path":["search","download-csv",":download_request_id",":id"],"variable":[{"key":"download_request_id"},{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/csv"}],"cookie":[],"responseTime":null,"body":"{\n \"incididunt_d\": {},\n \"dolor_3\": {}\n}"}],"_postman_id":"bb9f6ee1-63b4-4651-9fa1-1b850f2622d9"},{"name":"Download Status","id":"b29de70f-e2e0-4815-837c-3261f83de343","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/search/download-csv/:id","description":"

You can check the status of a specific Task by ID. You may implement logic to requery the status until the\nstatus is 'Completed'. If an 'Error' is encountered you will have to start a new Download Task.

\n","urlObject":{"path":["search","download-csv",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"4812fbd7-0bdc-42df-a73a-1b9197f2a034","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"19a3e69b-1914-4c4e-b0c5-4a29bf80ede5","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-NOPSEC-API-KEY","value":""}],"url":{"raw":"{{baseUrl}}/search/download-csv/:id","host":["{{baseUrl}}"],"path":["search","download-csv",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"download_query\": {\n \"group_by\": \"VULNERABILITY\",\n \"sort_by\": \"\",\n \"query\": {},\n \"saved_report_id\": \"\",\n \"saved_query_id\": \"\",\n \"saved_column_group_by_id\": \"\",\n \"data_fields\": [\n \"\",\n \"\"\n ],\n \"agg_fields\": [\n \"\",\n \"\"\n ],\n \"ids\": [\n \"\",\n \"\"\n ],\n \"max_download_limit\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n },\n \"download_request_id\": \"\",\n \"file_attachment_ids\": \"\",\n \"id\": \"\",\n \"urls\": \"\",\n \"status\": \"ERROR\"\n}"}],"_postman_id":"b29de70f-e2e0-4815-837c-3261f83de343"}],"id":"848f037c-7408-49a7-9a6a-e986b1868e0c","_postman_id":"848f037c-7408-49a7-9a6a-e986b1868e0c","description":""},{"name":"Ingestion","item":[{"name":"Tags File Upload","id":"a965f405-945e-402d-9d00-1d8576ae2e3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"

CSV file to be uploaded with headers [target_id,tag_key,tag_value,action,new_value]

\n","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/nitinkumar/Downloads/demo_tag_upload_api.csv"],"value":null}]},"url":"{{baseUrl}}/ingestion/tags/upload","description":"

This API allows clients to upload CSV files to manage tags associated with their targets. The tags can be added, modified, or removed based on the specified actions within the CSV file.

\n

CSV Format Requirements:

\n

The uploaded CSV file must include the following headers:

\n
    \n

  • target_id (required): Unique identifier of the target.

    \n
    • \n

  • tag_key (required): The key of the tag to manage.

    \n
    • \n

  • tag_value (conditional): The value of the tag; required for add and modify actions.

    \n
    • \n

  • action (required): The action to perform. Valid options: add, modify, remove.

    \n
    • \n

  • new_value (conditional): The new value for the tag; required for the modify action.

    \n
    • \n
\n","urlObject":{"path":["ingestion","tags","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"9ca23dd4-bc35-4636-b72a-d204df6befd4","name":"Successfully Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"CSV file to be uploaded with headers [target_id,tag_key,tag_value,action,new_value]","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/nitinkumar/Downloads/demo_tag_upload_api.csv"],"value":null}]},"url":"{{baseUrl}}/ingestion/tags/upload"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\"Tags ingestion task successfully created.\""},{"id":"c67351e6-51cd-4279-aec2-cb36a2a48700","name":"File not provided","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"CSV file to be uploaded with headers [target_id,tag_key,tag_value,action,new_value]","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/nitinkumar/Downloads/demo_tag_upload_api.csv"],"value":null}]},"url":"{{baseUrl}}/ingestion/tags/upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"file\": [\n \"The submitted data was not a file. Check the encoding type on the form.\"\n ]\n}"},{"id":"822abf92-b076-4bcc-b77d-a9702827e60f","name":"Invalid CSV headers","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"CSV file to be uploaded with headers [target_id,tag_key,tag_value,action,new_value]","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/nitinkumar/Downloads/demo_tag_upload_api.csv"],"value":null}]},"url":"{{baseUrl}}/ingestion/tags/upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"file\": [\n \"Invalid CSV headers. Expected ['target_id', 'tag_key', 'tag_value', 'action', 'new_value'] but got ['target_id', 'tag_key', 'tag_value', 'action']\"\n ]\n}"},{"id":"9f7e910e-5128-4644-bf74-9c9531c9f114","name":"File size is too large","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"CSV file to be uploaded with headers [target_id,tag_key,tag_value,action,new_value]","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/nitinkumar/Downloads/demo_tag_upload_api.csv"],"value":null}]},"url":"{{baseUrl}}/ingestion/tags/upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"file\": [\n \"File size exceeds 9.5367431640625e-07 MB\"\n ]\n}"}],"_postman_id":"a965f405-945e-402d-9d00-1d8576ae2e3c"}],"id":"53c03821-c0b8-45be-a8b5-5b2e930890fc","description":"

This ingestions APIs is designed to ingestion of client data into our system. It includes endpoints that facilitate data submission, validation, and storage, ensuring a seamless and efficient integration process.

\n","_postman_id":"53c03821-c0b8-45be-a8b5-5b2e930890fc"},{"name":"AuditLog","item":[{"name":"List Audit Logs","id":"910251ea-3823-4ae9-86cf-e6990b24fa2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-NOPSEC-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/auditlog/log?created_after=1958-05-09T01:30:49.964Z&created_at=1980-08-29&created_at_exact=1958-05-09T01:30:49.964Z&created_at_gt=1958-05-09T01:30:49.964Z&created_at_gte=1958-05-09T01:30:49.964Z&created_at_lt=1958-05-09T01:30:49.964Z&created_at_lte=1958-05-09T01:30:49.964Z&created_before=1958-05-09T01:30:49.964Z&limit=6100&offset=6100&ordering=string&trigger_source=API&action_type=UPDATE","description":"

Retrieve a paginated list of audit logs for the authenticated user's client with filtering and search capabilities.

\n","urlObject":{"path":["auditlog","log"],"host":["{{baseUrl}}"],"query":[{"key":"created_after","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at","value":"1980-08-29"},{"key":"created_at_exact","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at_gt","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at_gte","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at_lt","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at_lte","value":"1958-05-09T01:30:49.964Z"},{"key":"created_before","value":"1958-05-09T01:30:49.964Z"},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"limit","value":"6100"},{"description":{"content":"

The initial index from which to return the results.

\n","type":"text/plain"},"key":"offset","value":"6100"},{"description":{"content":"

Which field to use when ordering the results.

\n","type":"text/plain"},"key":"ordering","value":"string"},{"description":{"content":"

Source that triggered the audit log

\n
    \n
  • GUI - GUI
    • \n
  • CLIENT_MANAGEMENT - Client Management
    • \n
  • AUTOMATED - Automated
    • \n
  • API - API
    • \n
  • SYSTEM - System
    • \n
\n","type":"text/plain"},"key":"trigger_source","value":"API"},{"description":{"content":"

Type of action performed

\n
    \n
  • CREATE - Create
    • \n
  • UPDATE - Update
    • \n
  • DELETE - Delete
    • \n
  • LOGIN - Login
    • \n
  • LOGOUT - Logout
    • \n
  • TEST - Test
    • \n
  • TEAM_MEMBERSHIP_ADD - Team Membership Add
    • \n
  • TEAM_MEMBERSHIP_REMOVE - Team Membership Remove
    • \n
  • TEAM_MEMBERSHIP_CLEAR - Team Membership Clear
    • \n
  • REMEDIATION_PLAN_TEAM_ADD - Remediation Plan Team Add
    • \n
  • REMEDIATION_PLAN_TEAM_REMOVE - Remediation Plan Team Remove
    • \n
  • REMEDIATION_PLAN_TEAM_CLEAR - Remediation Plan Team Clear
    • \n
  • EXCEPTION_PLAN_TEAM_ADD - Exception Plan Team Add
    • \n
  • EXCEPTION_PLAN_TEAM_REMOVE - Exception Plan Team Remove
    • \n
  • EXCEPTION_PLAN_TEAM_CLEAR - Exception Plan Team Clear
    • \n
  • DERIVED_FIELD_RULE_ADD - Derived Field Rule Add
    • \n
  • DERIVED_FIELD_RULE_REMOVE - Derived Field Rule Remove
    • \n
  • DERIVED_FIELD_RULE_CLEAR - Derived Field Rule Clear
    • \n
\n","type":"text/plain"},"key":"action_type","value":"UPDATE"}],"variable":[]}},"response":[{"id":"40bf8ddd-9b6c-44a6-b89c-4b4ccc69f9b6","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-NOPSEC-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"{{baseUrl}}/auditlog?action_description=string&action_type=LOGIN&created_after=1958-05-09T01:30:49.964Z&created_at=1980-08-29&created_at_exact=1958-05-09T01:30:49.964Z&created_at_gt=1958-05-09T01:30:49.964Z&created_at_gte=1958-05-09T01:30:49.964Z&created_at_lt=1958-05-09T01:30:49.964Z&created_at_lte=1958-05-09T01:30:49.964Z&created_before=1958-05-09T01:30:49.964Z&limit=6100&offset=6100&ordering=string&search=string&trigger_source=API&user_id=6100&username=string","host":["{{baseUrl}}"],"path":["auditlog"],"query":[{"key":"action_description","value":"string"},{"key":"action_type","value":"LOGIN","description":"Type of action performed\n\n* `CREATE` - Create\n* `UPDATE` - Update\n* `DELETE` - Delete\n* `LOGIN` - Login\n* `LOGOUT` - Logout\n* `TEST` - Test\n* `TEAM_MEMBERSHIP_ADD` - Team Membership Add\n* `TEAM_MEMBERSHIP_REMOVE` - Team Membership Remove\n* `TEAM_MEMBERSHIP_CLEAR` - Team Membership Clear\n* `REMEDIATION_PLAN_TEAM_ADD` - Remediation Plan Team Add\n* `REMEDIATION_PLAN_TEAM_REMOVE` - Remediation Plan Team Remove\n* `REMEDIATION_PLAN_TEAM_CLEAR` - Remediation Plan Team Clear\n* `EXCEPTION_PLAN_TEAM_ADD` - Exception Plan Team Add\n* `EXCEPTION_PLAN_TEAM_REMOVE` - Exception Plan Team Remove\n* `EXCEPTION_PLAN_TEAM_CLEAR` - Exception Plan Team Clear\n* `DERIVED_FIELD_RULE_ADD` - Derived Field Rule Add\n* `DERIVED_FIELD_RULE_REMOVE` - Derived Field Rule Remove\n* `DERIVED_FIELD_RULE_CLEAR` - Derived Field Rule Clear"},{"key":"created_after","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at","value":"1980-08-29"},{"key":"created_at_exact","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at_gt","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at_gte","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at_lt","value":"1958-05-09T01:30:49.964Z"},{"key":"created_at_lte","value":"1958-05-09T01:30:49.964Z"},{"key":"created_before","value":"1958-05-09T01:30:49.964Z"},{"key":"limit","value":"6100","description":"Number of results to return per page."},{"key":"offset","value":"6100","description":"The initial index from which to return the results."},{"key":"ordering","value":"string","description":"Which field to use when ordering the results."},{"key":"search","value":"string","description":"A search term."},{"key":"trigger_source","value":"API","description":"Source that triggered the audit log\n\n* `GUI` - GUI\n* `CLIENT_MANAGEMENT` - Client Management\n* `AUTOMATED` - Automated\n* `API` - API\n* `SYSTEM` - System"},{"key":"user_id","value":"6100"},{"key":"username","value":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 123,\n \"next\": \"{{baseUrl}}/auditlog/log?offset=400&limit=100\",\n \"previous\": \"{{baseUrl}}/auditlog/log?offset=200&limit=100\",\n \"results\": [\n {\n \"id\": \"48b9eb82-fc2d-4920-880e-45debbc992eb\",\n \"username\": \"username\",\n \"user_id\": \"user id\",\n \"action_type\": \"UPDATE\",\n \"action_description\": \"Settings updated: username\",\n \"reference\": \"Settings:Id:48b9eb82-fc2d-4920-880e-45debbc992eb\",\n \"trigger_source\": \"GUI\",\n \"created_at\": \"2025-10-07T18:44:42.025453Z\"\n }\n ]\n}"}],"_postman_id":"910251ea-3823-4ae9-86cf-e6990b24fa2e"}],"id":"22a5152f-e0e0-4b97-a001-1b7ec8072a4a","_postman_id":"22a5152f-e0e0-4b97-a001-1b7ec8072a4a","description":""}],"event":[{"listen":"prerequest","script":{"id":"2ecb7345-0ccc-476f-ad15-15059288162f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"542ff057-427d-4ff0-ba0c-ba6b83dffb0f","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"/api","disabled":true}]}