APIs.io Engineering Platform WHOIS Record 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 WHOIS Record API
  version: 4.0.0
tags:
- name: WHOIS Record
paths:
  /accounts/{account_id}/intel/whois:
    get:
      operationId: whois-record-get-whois-record
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: query
        name: domain
        schema:
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_schemas-single_response'
                - $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get WHOIS Record response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_schemas-single_response'
          description: Get WHOIS Record response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get WHOIS Record
      tags:
      - WHOIS Record
      x-api-token-group:
      - Intel Read
components:
  schemas:
    cloudforce-one_api-response-single:
      allOf:
      - $ref: '#/components/schemas/cloudforce-one_api-response-common'
      type: object
    cloudforce-one_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_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
    cloudforce-one_domain_name:
      example: cloudflare.com
      type: string
    cloudforce-one_schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/cloudforce-one_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/cloudforce-one_whois'
    cloudforce-one_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    cloudforce-one_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/cloudforce-one_messages'
        messages:
          $ref: '#/components/schemas/cloudforce-one_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    cloudforce-one_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    cloudforce-one_whois:
      properties:
        administrative_city:
          type: string
        administrative_country:
          type: string
        administrative_email:
          type: string
        administrative_fax:
          type: string
        administrative_fax_ext:
          type: string
        administrative_id:
          type: string
        administrative_name:
          type: string
        administrative_org:
          type: string
        administrative_phone:
          type: string
        administrative_phone_ext:
          type: string
        administrative_postal_code:
          type: string
        administrative_province:
          type: string
        administrative_referral_url:
          type: string
        administrative_street:
          type: string
        billing_city:
          type: string
        billing_country:
          type: string
        billing_email:
          type: string
        billing_fax:
          type: string
        billing_fax_ext:
          type: string
        billing_id:
          type: string
        billing_name:
          type: string
        billing_org:
          type: string
        billing_phone:
          type: string
        billing_phone_ext:
          type: string
        billing_postal_code:
          type: string
        billing_province:
          type: string
        billing_referral_url:
          type: string
        billing_street:
          type: string
        created_date:
          example: '2009-02-17T22:07:54.000Z'
          format: date-time
          type: string
        created_date_raw:
          example: '2009-02-17T22:07:54Z'
          type: string
        dnssec:
          example: true
          type: boolean
        domain:
          $ref: '#/components/schemas/cloudforce-one_domain_name'
        expiration_date:
          example: '2033-02-17T22:07:54.000Z'
          format: date-time
          type: string
        expiration_date_raw:
          example: '2033-02-17T22:07:54Z'
          type: string
        extension:
          example: com
          type: string
        found:
          example: true
          type: boolean
        id:
          example: 1542998887_DOMAIN_COM-VRSN
          type: string
        nameservers:
          example:
          - ns3.cloudflare.com
          - ns4.cloudflare.com
          - ns5.cloudflare.com
          - ns6.cloudflare.com
          - ns7.cloudflare.com
          items:
            type: string
          type: array
        punycode:
          example: cloudflare.com
          type: string
        registrant:
          type: string
        registrant_city:
          type: string
        registrant_country:
          type: string
        registrant_email:
          type: string
        registrant_fax:
          type: string
        registrant_fax_ext:
          type: string
        registrant_id:
          type: string
        registrant_name:
          type: string
        registrant_org:
          type: string
        registrant_phone:
          type: string
        registrant_phone_ext:
          type: string
        registrant_postal_code:
          type: string
        registrant_province:
          type: string
        registrant_referral_url:
          type: string
        registrant_street:
          type: string
        registrar:
          example: Cloudflare, Inc.
          type: string
        registrar_city:
          type: string
        registrar_country:
          type: string
        registrar_email:
          type: string
        registrar_fax:
          type: string
        registrar_fax_ext:
          type: string
        registrar_id:
          type: string
        registrar_name:
          type: string
        registrar_org:
          type: string
        registrar_phone:
          type: string
        registrar_phone_ext:
          type: string
        registrar_postal_code:
          type: string
        registrar_province:
          type: string
        registrar_referral_url:
          type: string
        registrar_street:
          type: string
        status:
          example:
          - clientdeleteprohibited
          - clienttransferprohibited
          - clientupdateprohibited
          - serverdeleteprohibited
          - servertransferprohibited
          - serverupdateprohibited
          items:
            type: string
          type: array
        technical_city:
          type: string
        technical_country:
          type: string
        technical_email:
          type: string
        technical_fax:
          type: string
        technical_fax_ext:
          type: string
        technical_id:
          type: string
        technical_name:
          type: string
        technical_org:
          type: string
        technical_phone:
          type: string
        technical_phone_ext:
          type: string
        technical_postal_code:
          type: string
        technical_province:
          type: string
        technical_referral_url:
          type: string
        technical_street:
          type: string
        updated_date:
          example: '2024-01-09T16:45:28.000Z'
          format: date-time
          type: string
        updated_date_raw:
          example: '2024-01-09T16:45:28Z'
          type: string
        whois_server:
          example: whois.cloudflare.com
          type: string
      required:
      - found
      - domain
      - dnnsec
      - extension
      - nameservers
      - punycode
      - registrar
      - registrant
  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