APIs.io Engineering Platform Phishing URL Scanner 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 Scanner API
  version: 4.0.0
tags:
- name: Phishing URL Scanner
paths:
  /accounts/{account_id}/brand-protection/submit:
    post:
      operationId: phishing-url-scanner-submit-suspicious-url-for-scanning
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/intel_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/intel_url_param'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/intel_phishing-url-submit_components-schemas-single_response'
                - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Submit suspicious URL for scanning response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_phishing-url-submit_components-schemas-single_response'
          description: Submit suspicious URL for scanning response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Submit suspicious URL for scanning
      tags:
      - Phishing URL Scanner
components:
  schemas:
    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_phishing-url-submit:
      properties:
        excluded_urls:
          description: URLs that were excluded from scanning because their domain is in our no-scan list.
          items:
            properties:
              url:
                description: URL that was excluded.
                example: https://developers.cloudflare.com
                type: string
            type: object
          type: array
        skipped_urls:
          description: URLs that were skipped because the same URL is currently being scanned
          items:
            properties:
              url:
                description: URL that was skipped.
                example: https://www.cloudflare.com/developer-week/
                type: string
              url_id:
                description: ID of the submission of that URL that is currently scanning.
                example: 2
                type: integer
            type: object
          type: array
        submitted_urls:
          description: URLs that were successfully submitted for scanning.
          items:
            properties:
              url:
                description: URL that was submitted.
                example: https://www.cloudflare.com
                type: string
              url_id:
                description: ID assigned to this URL submission. Used to retrieve scanning results.
                example: 1
                type: integer
            type: object
          type: array
    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_url_param:
      properties:
        url:
          $ref: '#/components/schemas/intel_url'
      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_url:
      description: URL(s) to filter submissions results by
      example: https://www.cloudflare.com
      format: uri
      type: string
    intel_phishing-url-submit_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/intel_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/intel_phishing-url-submit'
  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