APIs.io Engineering Platform Radar Search 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 Radar Search API
  version: 4.0.0
tags:
- name: Radar Search
paths:
  /radar/search/global:
    get:
      description: Lets you search for locations, autonomous systems (AS) and reports.
      operationId: radar-get-search-global
      parameters:
      - description: Limit the number of objects in the response.
        in: query
        name: limit
        schema:
          description: Limit the number of objects in the response.
          example: 5
          type: integer
      - description: Limit the number of objects per search category.
        in: query
        name: limitPerGroup
        schema:
          description: Limit the number of objects per search category.
          type: number
      - description: Search for locations, AS and reports.
        in: query
        name: query
        required: true
        schema:
          description: Search for locations, AS and reports.
          example: United
          type: string
      - description: Search types to be included in results.
        in: query
        name: include
        schema:
          description: Search types to be included in results.
          items:
            enum:
            - SPECIAL_EVENTS
            - NOTEBOOKS
            - LOCATIONS
            - ASNS
            type: string
          type: array
      - description: Search types to be excluded from results.
        in: query
        name: exclude
        schema:
          description: Search types to be excluded from results.
          items:
            enum:
            - SPECIAL_EVENTS
            - NOTEBOOKS
            - LOCATIONS
            - ASNS
            type: string
          type: array
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      search:
                        items:
                          properties:
                            code:
                              example: '13335'
                              type: string
                            name:
                              example: Cloudflare
                              type: string
                            type:
                              example: asn
                              type: string
                          required:
                          - code
                          - name
                          - type
                          type: object
                        type: array
                    required:
                    - search
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                - result
                - success
                - errors
                type: object
          description: Bad Request
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Search for locations, autonomous systems (AS) and reports.
      tags:
      - Radar Search
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  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