{
  "opencollection": "1.0.0",
  "info": {
    "name": "PDCP agents Scans API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-API-Key",
      "value": "{{X-API-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Scans",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create vulns export to tracker",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.projectdiscovery.io/v1/scans/vulns/:vuln_id/ticket",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "vuln_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "reporting_config_id",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Create vulns export to tracker"
        },
        {
          "info": {
            "name": "Delete vulns tracker association",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.projectdiscovery.io/v1/scans/vulns/:vuln_id/ticket",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "vuln_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "provider_name",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete vulns export tracker"
        },
        {
          "info": {
            "name": "Get error statistics of given scan id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/error_stats",
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get error statistics of given scan id"
        },
        {
          "info": {
            "name": "Get Scan List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "number of scan-status results to skip"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "number of scan-status results to fetch"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "search term for running scans"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "filter by status (failed, finished, queued, running, starting, uploaded, scheduled)"
              },
              {
                "name": "sort_asc",
                "value": "",
                "type": "query",
                "description": "comma separated ascending sorting e.g sort_asc=created_at,severity"
              },
              {
                "name": "sort_desc",
                "value": "",
                "type": "query",
                "description": "comma separated descending sorting e.g sort_desc=created_at,severity"
              },
              {
                "name": "is_internal",
                "value": "",
                "type": "query",
                "description": "filter by internal scans"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get user scans status"
        },
        {
          "info": {
            "name": "Create Scan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.projectdiscovery.io/v1/scans",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Trigger a scan"
        },
        {
          "info": {
            "name": "Delete Scan in bulk",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.projectdiscovery.io/v1/scans",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete scans using scan ids"
        },
        {
          "info": {
            "name": "Get Scan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get details of a scan by scan ID"
        },
        {
          "info": {
            "name": "Update Scan",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update scan metadata"
        },
        {
          "info": {
            "name": "Delete Scan",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete a scan using scanId"
        },
        {
          "info": {
            "name": "Import OSS Scan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.projectdiscovery.io/v1/scans/import",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Import scan details"
        },
        {
          "info": {
            "name": "Stop Scan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/stop",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Stop a running scan, not applied in any other state."
        },
        {
          "info": {
            "name": "Rescan scan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/rescan",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Re-run a existing scan"
        },
        {
          "info": {
            "name": "Get All Scan Stats",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/stats",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get all scans statistics for a user"
        },
        {
          "info": {
            "name": "Retest vulnerability",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.projectdiscovery.io/v1/scans/:vuln_id/retest",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "vuln_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Retest a scan vulnerability"
        },
        {
          "info": {
            "name": "Get Scan Schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/schedule",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get scan schedules for a user"
        },
        {
          "info": {
            "name": "Set Scan Schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.projectdiscovery.io/v1/scans/schedule",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "set a scan schedule for a user "
        },
        {
          "info": {
            "name": "Delete Scan Schedule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.projectdiscovery.io/v1/scans/schedule",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "query",
                "description": "scan_id of schedule to be deleted"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete scan schedule for a user"
        },
        {
          "info": {
            "name": "Get Scan IPs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/scan_ips",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get user static scan IPs list"
        },
        {
          "info": {
            "name": "Update Imported Scan",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/import",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Import more results to a given scan"
        },
        {
          "info": {
            "name": "Export Scan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/export",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "async",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "json, csv, pdf (default json)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Export scan results"
        },
        {
          "info": {
            "name": "Export Filtered Scan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/export",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "async",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "json, csv, pdf (default json)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Export filtered scan results"
        },
        {
          "info": {
            "name": "Export Scan Vulnerability",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/vuln/:vuln_id/export",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "vuln_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "json, csv (default json)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Export a specific scan vulnerability"
        },
        {
          "info": {
            "name": "Update Vulnerability Status",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.projectdiscovery.io/v1/scans/vulns",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Batch update vulnerability status"
        },
        {
          "info": {
            "name": "Delete Scan Vulnerability",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.projectdiscovery.io/v1/scans/vulns",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Batch Delete scan vulnerability"
        },
        {
          "info": {
            "name": "Update Vulnerability Labels",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.projectdiscovery.io/v1/scans/vulns/labels",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Batch update vulnerability labels"
        },
        {
          "info": {
            "name": "Get Scan Config",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/config",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get scan metadata config "
        },
        {
          "info": {
            "name": "Update Scan Config",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/config",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "update_type",
                "value": "",
                "type": "query",
                "description": "Update type: append or replace"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update scan metadata config"
        },
        {
          "info": {
            "name": "Get All Scans History",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/history",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "number of rows to skip"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "number of rows to get"
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "start date from which you want to get history"
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "end date till which you want to get history"
              },
              {
                "name": "time_range",
                "value": "",
                "type": "query",
                "description": "time range to get history"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get user scan history details"
        },
        {
          "info": {
            "name": "Get Scan History",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/:scanId/history",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scanId",
                "value": "",
                "type": "path"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "number of rows to skip"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "number of rows to get"
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "start date from which you want to get history"
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "end date till which you want to get history"
              },
              {
                "name": "time_range",
                "value": "",
                "type": "query",
                "description": "time range to get history"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get scan history detial by scanId"
        },
        {
          "info": {
            "name": "Get list of unique assets scanned in current month.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/asset",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Search with host or port"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of assets (Default 100)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset the number of assets (Default 0)"
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Start date of the range. If not provided, it will be the first day of the current billing cycle."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "End date of the range. If not provided, it will be the last day of the current billing cycle."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type of asset to filter by. Supported values are host, if not provided, it will return all assets."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "List of all unique assets scanned in the current month."
        },
        {
          "info": {
            "name": "Export list of unique assets scanned in current month",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/asset/export",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Search with host or port"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "supported format is csv, json, or raw (default json)"
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Start date of the range. If not provided, it will be the first day of the current billing cycle."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "End date of the range. If not provided, it will be the last day of the current billing cycle."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type of asset to filter by. Supported values are host, if not provided, it will return all assets."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Export the list of all unique assets scanned in the current month."
        },
        {
          "info": {
            "name": "Get list of unique assets for a scan.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/asset",
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Search with host or port"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of assets (Default 100)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset the number of assets (Default 0)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "List of all unique assets for a scan."
        },
        {
          "info": {
            "name": "Export list of unique assets for a scan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/:scan_id/asset/export",
            "params": [
              {
                "name": "scan_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Search with host or port"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "supported format is csv, json, or raw (default json)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Export the list of all unique assets for a scan."
        },
        {
          "info": {
            "name": "Get Scans Token",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.projectdiscovery.io/v1/scans/token",
            "headers": [
              {
                "name": "X-Team-Id",
                "value": ""
              }
            ]
          },
          "docs": "Get user scan token usage details"
        }
      ]
    }
  ],
  "bundled": true
}