APIs.io Engineering Platform URL Scanner API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 URL Scanner API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: URL Scanner
paths:
  /accounts/{accountId}/urlscanner/scan:
    get:
      description: 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.
      operationId: urlscanner-search-scans
      parameters:
      - description: Account Id
        in: path
        name: accountId
        required: true
        schema:
          description: Account Id
          type: string
      - description: Scan uuid
        in: query
        name: scanId
        schema:
          description: Scan uuid
          format: uuid
          type: string
      - description: Limit the number of objects in the response.
        in: query
        name: limit
        schema:
          description: Limit the number of objects in the response.
          example: 100
          type: integer
      - description: Pagination cursor to get the next set of results.
        in: query
        name: next_cursor
        schema:
          description: Pagination cursor to get the next set of results.
          type: string
      - description: Filter scans requested after date (inclusive).
        in: query
        name: date_start
        schema:
          description: Filter scans requested after date (inclusive).
          format: date-time
          type: string
      - description: Filter scans requested before date (inclusive).
        in: query
        name: date_end
        schema:
          description: Filter scans requested before date (inclusive).
          format: date-time
          type: string
      - description: Filter scans by URL of _any_ request made by the webpage
        in: query
        name: url
        schema:
          description: Filter scans by URL of _any_ request made by the webpage
          example: https://example.com/?hello
          type: string
      - description: Filter scans by hostname of _any_ request made by the webpage.
        in: query
        name: hostname
        schema:
          description: Filter scans by hostname of _any_ request made by the webpage.
          example: example.com
          type: string
      - description: Filter scans by url path of _any_ request made by the webpage.
        in: query
        name: path
        schema:
          description: Filter scans by url path of _any_ request made by the webpage.
          example: /samples/subresource-integrity/
          type: string
      - description: Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage.
        in: query
        name: ip
        schema:
          description: Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage.
          example: 1.1.1.1
          type: string
      - description: Filter scans by Autonomous System Number (ASN) of _any_ request made by the webpage.
        in: query
        name: asn
        schema:
          description: Filter scans by Autonomous System Number (ASN) of _any_ request made by the webpage.
          example: '13335'
          type: string
      - description: Filter scans by hash of any html/js/css request made by the webpage.
        in: query
        name: hash
        schema:
          description: Filter scans by hash of any html/js/css request made by the webpage.
          type: string
      - description: Filter scans by submitted or scanned URL
        in: query
        name: page_url
        schema:
          description: Filter scans by submitted or scanned URL
          type: string
      - description: Filter scans by main page hostname (domain of effective URL).
        in: query
        name: page_hostname
        schema:
          description: Filter scans by main page hostname (domain of effective URL).
          type: string
      - description: Filter scans by exact match of effective URL path (also supports suffix search).
        in: query
        name: page_path
        schema:
          description: Filter scans by exact match of effective URL path (also supports suffix search).
          type: string
      - description: Filter scans by main page Autonomous System Number (ASN).
        in: query
        name: page_asn
        schema:
          description: Filter scans by main page Autonomous System Number (ASN).
          type: string
      - description: Filter scans by  main page IP address (IPv4 or IPv6).
        in: query
        name: page_ip
        schema:
          description: Filter scans by  main page IP address (IPv4 or IPv6).
          type: string
      - description: Return only scans created by account.
        in: query
        name: account_scans
        schema:
          description: Return only scans created by account.
          type: boolean
      - description: Filter scans by malicious verdict.
        in: query
        name: is_malicious
        schema:
          description: Filter scans by malicious verdict.
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Error
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: OK
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    properties:
                      tasks:
                        items:
                          properties:
                            country:
                              description: Alpha-2 country code
                              type: string
                            success:
                              description: Whether scan was successful or not
                              type: boolean
                            time:
                              description: When scan was submitted (UTC)
                              format: date-time
                              type: string
                            url:
                              description: Scan url (after redirects)
                              example: https://www.example.com/
                              type: string
                            uuid:
                              description: Scan id
                              format: uuid
                              type: string
                            visibility:
                              description: Visibility status.
                              example: public
                              type: string
                          required:
                          - uuid
                          - url
                          - success
                          - time
                          - country
                          - visibility
                          type: object
                        type: array
                    required:
                    - tasks
                    type: object
                  success:
                    description: Whether search request was successful or not
                    type: boolean
                required:
                - messages
                - errors
                - success
                - result
                type: object
          description: Search results
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan ID is not a valid uuid.
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                - messages
                - errors
                - success
                type: object
          description: Invalid params.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Search URL scans
      tags:
      - URL Scanner
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.url-scanner.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: 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/.
      operationId: urlscanner-create-scan
      parameters:
      - description: Account Id
        in: path
        name: accountId
        required: true
        schema:
          description: Account Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                customHeaders:
                  additionalProperties:
                    type: string
                  description: Set custom headers
                  type: object
                screenshotsResolutions:
                  default:
                  - desktop
                  description: Take multiple screenshots targeting different device types
                  items:
                    default: desktop
                    description: Device resolutions.
                    enum:
                    - desktop
                    - mobile
                    - tablet
                    type: string
                  type: array
                url:
                  example: https://www.example.com
                  type: string
                visibility:
                  default: Public
                  description: The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material.
                  enum:
                  - Public
                  - Unlisted
                  type: string
              required:
              - url
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Submission unsuccessful
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: Submission successful
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    properties:
                      time:
                        description: Time when url was submitted for scanning.
                        format: date-time
                        type: string
                      url:
                        description: Canonical form of submitted URL. Use this if you want to later search by URL.
                        type: string
                      uuid:
                        description: Scan ID.
                        format: uuid
                        type: string
                      visibility:
                        description: Submitted visibility status.
                        example: Public
                        type: string
                    required:
                    - visibility
                    - uuid
                    - url
                    - time
                    type: object
                  success:
                    type: boolean
                required:
                - messages
                - errors
                - success
                - result
                type: object
          description: Scan request accepted successfully.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan ID is not a valid uuid.
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                - messages
                - errors
                - success
                type: object
          description: Invalid params.
        '409':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Submission unsuccessful
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    properties:
                      tasks:
                        items:
                          properties:
                            clientLocation:
                              description: Submitter location
                              example: PT
                              type: string
                            clientType:
                              enum:
                              - Site
                              - Automatic
                              - Api
                              type: string
                            effectiveUrl:
                              description: URL of the primary request, after all HTTP redirects
                              example: http://example.com/
                              type: string
                            errors:
                              items:
                                properties:
                                  message:
                                    type: string
                                required:
                                - message
                                type: object
                              type: array
                            scannedFrom:
                              properties:
                                colo:
                                  description: IATA code of Cloudflare datacenter
                                  example: MAD
                                  type: string
                              required:
                              - colo
                              type: object
                            status:
                              enum:
                              - Queued
                              - InProgress
                              - InPostProcessing
                              - Finished
                              type: string
                            success:
                              example: true
                              type: boolean
                            time:
                              example: '2023-05-03T17:05:04.843Z'
                              type: string
                            timeEnd:
                              example: '2023-05-03T17:05:19.374Z'
                              type: string
                            url:
                              description: Submitted URL
                              example: http://example.com
                              type: string
                            uuid:
                              description: Scan ID
                              example: 2ee568d0-bf70-4827-b922-b7088c0f056f
                              type: string
                            visibility:
                              enum:
                              - Public
                              - Unlisted
                              type: string
                          required:
                          - uuid
                          - url
                          - status
                          - success
                          - errors
                          - time
                          - timeEnd
                          - visibility
                          - clientLocation
                          - clientType
                          - effectiveUrl
                          - scannedFrom
                          type: object
                        type: array
                    required:
                    - tasks
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - messages
                - errors
                - success
                - result
                type: object
          description: 'Scan request denied: hostname was recently scanned.'
        '429':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Submission unsuccessful
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  success:
                    example: true
                    type: boolean
                required:
                - messages
                - errors
                - success
                type: object
          description: 'Scan request denied: rate limited.'
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create URL Scan
      tags:
      - URL Scanner
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.url-scanner.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{accountId}/urlscanner/scan/{scanId}:
    get:
      description: Get URL scan by uuid
      operationId: urlscanner-get-scan
      parameters:
      - description: Scan uuid
        in: path
        name: scanId
        required: true
        schema:
          description: Scan uuid
          format: uuid
          type: string
      - description: Account Id
        in: path
        name: accountId
        required: true
        schema:
          description: Account Id
          type: string
      - description: Whether to return full report (scan summary and network log).
        in: query
        name: full
        schema:
          description: Whether to return full report (scan summary and network log).
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Error
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: OK
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    properties:
                      scan:
                        properties:
                          asns:
                            description: Dictionary of Autonomous System Numbers where ASN's are the keys
                            properties:
                              asn:
                                description: ASN's contacted
                                properties:
                                  asn:
                                    example: '15133'
                                    type: string
                                  description:
                                    example: EDGECAST
                                    type: string
                                  location_alpha2:
                                    example: US
                                    type: string
                                  name:
                                    example: EDGECAST
                                    type: string
                                  org_name:
                                    example: Edgecast Inc.
                                    type: string
                                required:
                                - asn
                                - name
                                - description
                                - org_name
                                - location_alpha2
                                type: object
                            type: object
                          certificates:
                            items:
                              properties:
                                issuer:
                                  type: string
                                subjectName:
                                  example: rkmod.somee.com
                                  type: string
                                validFrom:
                                  example: 1682684400.0
                                  type: number
                                validTo:
                                  example: 1696698000.0
                                  type: number
                              required:
                              - issuer
                              - subjectName
                              - validFrom
                              - validTo
                              type: object
                            type: array
                          domains:
                            properties:
                              example.com:
                                properties:
                                  categories:
                                    properties:
                                      content:
                                        items:
                                          properties:
                                            id:
                                              type: integer
                                            name:
                                              example: Technology
                                              type: string
                                            super_category_id:
                                              type: integer
                                          required:
                                          - id
                                          - name
                                          type: object
                                        type: array
                                      inherited:
                                        properties:
                                          content:
                                            items:
                                              properties:
                                                id:
                                                  type: integer
                                                name:
                                                  example: Technology
                                                  type: string
                                                super_category_id:
                                                  type: integer
                                              required:
                                              - id
                                              - name
                                              type: object
                                            type: array
                                          from:
                                            example: example.com
                                            type: string
                                          risks:
                                            items:
                                              properties:
                                                id:
                                                  type: integer
                                                name:
                                                  example: Technology
                                                  type: string
                                                super_category_id:
                                                  type: integer
                                              required:
                                              - id
                                              - name
                                              type: object
                                            type: array
                                        type: object
                                      risks:
                                        items:
                                          properties:
                                            id:
                                              type: integer
                                            name:
                                              example: Technology
                                              type: string
                                            super_category_id:
                                              type: integer
                                          required:
                                          - id
                                          - name
                                          type: object
                                        type: array
                                    required:
                                    - inherited
                                    type: object
                                  dns:
                                    items:
                                      properties:
                                        address:
                                          example: 93.184.216.34
                                          type: string
                                        dnssec_valid:
                                          type: boolean
                                        name:
                                          example: example.com
                                          type: string
                                        type:
                                          example: A
                                          type: string
                                      required:
                   

# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-url-scanner-api-openapi.yml