APIs.io Engineering Platform Phishing URL Information API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Phishing URL Information API
  version: 4.0.0
tags:
- name: Phishing URL Information
paths:
  /accounts/{account_id}/brand-protection/url-info:
    get:
      operationId: phishing-url-information-get-results-for-a-url-scan
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/intel_identifier'
      - description: Submission ID(s) to filter submission results by.
        example:
        - 100
        - 200
        explode: true
        in: query
        name: url_id
        schema:
          items:
            type: integer
          type: array
        style: form
      - description: Submission URL(s) to filter submission results by.
        example:
        - https://foo.com
        - https://bar.com
        explode: true
        in: query
        name: url
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/intel_phishing-url-info_components-schemas-single_response'
                - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get results for a URL scan response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_phishing-url-info_components-schemas-single_response'
          description: Get results for a URL scan response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get results for a URL scan
      tags:
      - Phishing URL Information
components:
  schemas:
    intel_phishing-url-info:
      properties:
        categorizations:
          description: List of categorizations applied to this submission.
          items:
            properties:
              category:
                description: Name of the category applied.
                example: PHISHING
                type: string
              verification_status:
                description: Result of human review for this categorization.
                example: confirmed
                type: string
            type: object
          type: array
        model_results:
          description: List of model results for completed scans.
          items:
            properties:
              model_name:
                description: Name of the model.
                example: MACHINE_LEARNING_v2
                type: string
              model_score:
                description: Score output by the model for this submission.
                example: 0.024
                type: number
            type: object
          type: array
        rule_matches:
          description: List of signatures that matched against site content found when crawling the URL.
          items:
            properties:
              banning:
                description: For internal use.
                type: boolean
              blocking:
                description: For internal use.
                type: boolean
              description:
                description: Description of the signature that matched.
                example: Match frequently used social followers phishing kit
                type: string
              name:
                description: Name of the signature that matched.
                example: phishkit.social_followers
                type: string
            type: object
          type: array
        scan_status:
          description: Status of the most recent scan found.
          properties:
            last_processed:
              description: Timestamp of when the submission was processed.
              example: Wed, 26 Oct 2022 16:04:51 GMT
              type: string
            scan_complete:
              description: For internal use.
              type: boolean
            status_code:
              description: Status code that the crawler received when loading the submitted URL.
              type: integer
            submission_id:
              description: ID of the most recent submission.
              type: integer
          type: object
        screenshot_download_signature:
          description: For internal use.
          type: string
        screenshot_path:
          description: For internal use.
          type: string
        url:
          description: URL that was submitted.
          example: https://www.cloudflare.com
          type: string
    intel_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    intel_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    intel_api-response-single:
      allOf:
      - $ref: '#/components/schemas/intel_schemas-api-response-common'
      type: object
    intel_schemas-api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/intel_messages'
        messages:
          $ref: '#/components/schemas/intel_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    intel_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/intel_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/intel_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    intel_phishing-url-info_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/intel_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/intel_phishing-url-info'
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey