APIs.io Engineering Platform Phishing URL Information 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 Information 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 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_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/intel_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/intel_phishing-url-info'
    intel_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    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_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_api-response-single:
      allOf:
      - $ref: '#/components/schemas/intel_schemas-api-response-common'
      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