APIs.io Engineering Platform Domain Intelligence 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 Domain Intelligence API
  version: 4.0.0
tags:
- name: Domain Intelligence
paths:
  /accounts/{account_id}/intel/domain:
    get:
      operationId: domain-intelligence-get-domain-details
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/intel_identifier'
      - in: query
        name: domain
        schema:
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/intel_single_response'
                - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get Domain Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_single_response'
          description: Get Domain Details response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Domain Details
      tags:
      - Domain Intelligence
  /accounts/{account_id}/intel/domain/bulk:
    get:
      operationId: domain-intelligence-get-multiple-domain-details
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/intel_identifier'
      - in: query
        name: domain
        schema:
          description: Accepts multiple values, i.e. `?domain=cloudflare.com&domain=example.com`.
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/intel_collection_response'
                - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get Multiple Domain Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_collection_response'
          description: Get Multiple Domain Details response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Multiple Domain Details
      tags:
      - Domain Intelligence
components:
  schemas:
    intel_resolves_to_refs:
      description: Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to.
      items:
        $ref: '#/components/schemas/intel_resolves_to_ref'
      type: array
    intel_api-response-single:
      allOf:
      - $ref: '#/components/schemas/intel_schemas-api-response-common'
      type: object
    intel_domain:
      properties:
        additional_information:
          $ref: '#/components/schemas/intel_additional_information'
        application:
          $ref: '#/components/schemas/intel_application'
        content_categories:
          $ref: '#/components/schemas/intel_content_categories'
        domain:
          $ref: '#/components/schemas/intel_domain_name'
        inherited_content_categories:
          $ref: '#/components/schemas/intel_inherited_content_categories'
        inherited_from:
          $ref: '#/components/schemas/intel_inherited_from'
        inherited_risk_types:
          $ref: '#/components/schemas/intel_inherited_risk_types'
        popularity_rank:
          $ref: '#/components/schemas/intel_popularity_rank'
        resolves_to_refs:
          $ref: '#/components/schemas/intel_resolves_to_refs'
        risk_score:
          $ref: '#/components/schemas/intel_risk_score'
        risk_types:
          $ref: '#/components/schemas/intel_risk_types'
    intel_inherited_content_categories:
      $ref: '#/components/schemas/intel_categories_with_super_category_ids_example_empty'
    intel_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/intel_messages'
        messages:
          $ref: '#/components/schemas/intel_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    intel_category_with_super_category_id:
      properties:
        id:
          type: integer
        name:
          type: string
        super_category_id:
          type: integer
    intel_domain_name:
      example: cloudflare.com
      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_risk_score:
      description: Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk).
      type: number
    intel_collection_response:
      allOf:
      - $ref: '#/components/schemas/intel_api-response-collection'
      - properties:
          result:
            items:
              properties:
                additional_information:
                  $ref: '#/components/schemas/intel_additional_information'
                application:
                  $ref: '#/components/schemas/intel_application'
                content_categories:
                  $ref: '#/components/schemas/intel_content_categories'
                domain:
                  $ref: '#/components/schemas/intel_domain_name'
                inherited_content_categories:
                  $ref: '#/components/schemas/intel_inherited_content_categories'
                inherited_from:
                  $ref: '#/components/schemas/intel_inherited_from'
                inherited_risk_types:
                  $ref: '#/components/schemas/intel_inherited_risk_types'
                popularity_rank:
                  $ref: '#/components/schemas/intel_popularity_rank'
                risk_score:
                  $ref: '#/components/schemas/intel_risk_score'
                risk_types:
                  $ref: '#/components/schemas/intel_risk_types'
            type: array
    intel_inherited_from:
      description: Domain from which `inherited_content_categories` and `inherited_risk_types` are inherited, if applicable.
      type: string
    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
    intel_additional_information:
      description: Additional information related to the host name.
      properties:
        suspected_malware_family:
          description: Suspected DGA malware family.
          example: ''
          type: string
      type: object
    intel_single_response:
      allOf:
      - $ref: '#/components/schemas/intel_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/intel_domain'
    intel_stix_identifier:
      description: 'STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c'
      example: ipv4-addr--baa568ec-6efe-5902-be55-0663833db537
      type: string
    intel_popularity_rank:
      description: Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000.
      type: integer
    intel_categories_with_super_category_ids_example_empty:
      example: []
      items:
        $ref: '#/components/schemas/intel_category_with_super_category_id'
      type: array
    intel_risk_types:
      example: []
    intel_content_categories:
      description: Current content categories.
      example:
      - id: 155
        name: Technology
        super_category_id: 26
    intel_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    intel_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/intel_api-response-common'
      - properties:
          result:
            items: {}
            type:
            - array
            - 'null'
          result_info:
            $ref: '#/components/schemas/intel_result_info'
      type: object
    intel_application:
      description: Application that the hostname belongs to.
      properties:
        id:
          type: integer
        name:
          example: CLOUDFLARE
          type: string
      type: object
    intel_inherited_risk_types:
      $ref: '#/components/schemas/intel_categories_with_super_category_ids_example_empty'
    intel_resolves_to_ref:
      properties:
        id:
          $ref: '#/components/schemas/intel_stix_identifier'
        value:
          description: IP address or domain name.
          example: 192.0.2.0
          type: string
      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
  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