APIs.io Engineering Platform Phishing 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 Phishing 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: 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_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    intel_url:
      description: URL(s) to filter submissions results by
      example: https://www.cloudflare.com
      format: uri
      type: string
    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
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    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'
    intel_api-response-single:
      allOf:
      - $ref: '#/components/schemas/intel_schemas-api-response-common'
      type: object
    intel_url_param:
      properties:
        url:
          $ref: '#/components/schemas/intel_url'
      type: object
    intel_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    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
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true