{
  "opencollection": "1.0.0",
  "info": {
    "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 URL Scanner API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "URL Scanner",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "APIs.io Engineering Platform Search URL scans",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:accountId/urlscanner/scan",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Account Id"
              },
              {
                "name": "scanId",
                "value": "",
                "type": "query",
                "description": "Scan uuid"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of objects in the response."
              },
              {
                "name": "next_cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor to get the next set of results."
              },
              {
                "name": "date_start",
                "value": "",
                "type": "query",
                "description": "Filter scans requested after date (inclusive)."
              },
              {
                "name": "date_end",
                "value": "",
                "type": "query",
                "description": "Filter scans requested before date (inclusive)."
              },
              {
                "name": "url",
                "value": "",
                "type": "query",
                "description": "Filter scans by URL of _any_ request made by the webpage"
              },
              {
                "name": "hostname",
                "value": "",
                "type": "query",
                "description": "Filter scans by hostname of _any_ request made by the webpage."
              },
              {
                "name": "path",
                "value": "",
                "type": "query",
                "description": "Filter scans by url path of _any_ request made by the webpage."
              },
              {
                "name": "ip",
                "value": "",
                "type": "query",
                "description": "Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage."
              },
              {
                "name": "asn",
                "value": "",
                "type": "query",
                "description": "Filter scans by Autonomous System Number (ASN) of _any_ request made by the webpage."
              },
              {
                "name": "hash",
                "value": "",
                "type": "query",
                "description": "Filter scans by hash of any html/js/css request made by the webpage."
              },
              {
                "name": "page_url",
                "value": "",
                "type": "query",
                "description": "Filter scans by submitted or scanned URL"
              },
              {
                "name": "page_hostname",
                "value": "",
                "type": "query",
                "description": "Filter scans by main page hostname (domain of effective URL)."
              },
              {
                "name": "page_path",
                "value": "",
                "type": "query",
                "description": "Filter scans by exact match of effective URL path (also supports suffix search)."
              },
              {
                "name": "page_asn",
                "value": "",
                "type": "query",
                "description": "Filter scans by main page Autonomous System Number (ASN)."
              },
              {
                "name": "page_ip",
                "value": "",
                "type": "query",
                "description": "Filter scans by  main page IP address (IPv4 or IPv6)."
              },
              {
                "name": "account_scans",
                "value": "",
                "type": "query",
                "description": "Return only scans created by account."
              },
              {
                "name": "is_malicious",
                "value": "",
                "type": "query",
                "description": "Filter scans by malicious verdict."
              }
            ]
          },
          "docs": "Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path. <br/> A successful scan will appear in search results a few minutes after finishing but may take much longer if the system in under load. By default, only successfully completed scans will appear in search results, unless searching by `scanId`. Please take into account that older scans may be removed from the search index at an unspecified time."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Create URL Scan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:accountId/urlscanner/scan",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Account Id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get URL scan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:accountId/urlscanner/scan/:scanId",
            "params": [
              {
                "name": "scanId",
                "value": "",
                "type": "path",
                "description": "Scan uuid"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Account Id"
              },
              {
                "name": "full",
                "value": "",
                "type": "query",
                "description": "Whether to return full report (scan summary and network log)."
              }
            ]
          },
          "docs": "Get URL scan by uuid"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get URL scan's HAR",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:accountId/urlscanner/scan/:scanId/har",
            "params": [
              {
                "name": "scanId",
                "value": "",
                "type": "path",
                "description": "Scan uuid"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Account Id"
              }
            ]
          },
          "docs": "Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get screenshot",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:accountId/urlscanner/scan/:scanId/screenshot",
            "params": [
              {
                "name": "scanId",
                "value": "",
                "type": "path",
                "description": "Scan uuid"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Account Id"
              },
              {
                "name": "resolution",
                "value": "",
                "type": "query",
                "description": "Target device type"
              }
            ]
          },
          "docs": "Get scan's screenshot by resolution (desktop/mobile/tablet)."
        }
      ]
    }
  ],
  "bundled": true
}