---

openapi: '3.0.0'
info:
  title: Domains API reference
  version: '1.0.0'

servers:
- url: https://api.ukfast.io

security:
- api_key:
  - api_key

produces:
- application/json

tags:
- name: Domains
- name: WHOIS

paths:

  /registrar/v1/domains:
    get:
      description: List domains
      responses:
        '200':
          description: Success
          content:
            'default':
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/domain"
                  meta:
                    type: object
                    properties:
      tags:
      - Domains

  /registrar/v1/domains/{name}:
    parameters:
    - name: name
      in: path
      required: true
      description: The domains name
      schema:
        type: string

    get:
      description: Retrieve an individual domain
      responses:
        '200':
          description: Success
          content:
            'default':
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/domain"
                  meta:
                    type: object
                    properties:
      tags:
      - Domains

  /registrar/v1/domains/{name}/nameservers:
    parameters:
      - name: name
        in: path
        required: true
        description: The domains name
        schema:
          type: string

    get:
      description: Retrieve an individual domain's nameservers
      responses:
        '200':
          description: Success
          content:
            'default':
              schema:
                type: object
                properties:
                  data:
                    description: The domain's registered nameservers
                    type: array
                    items:
                      type: object
                      properties:
                        host:
                          description: Hostname of the assigned nameserver
                          type: string
                        ip:
                          description: IP of the assigned nameserver
                          type: string
                  meta:
                    type: object
                    properties:
      tags:
        - Domains


  /registrar/v1/whois/{name}:
    parameters:
      - name: name
        in: path
        required: true
        description: The domain name
        schema:
          type: string

    get:
      description: Retrieve WHOIS record for an individual domain
      responses:
        '200':
          description: Success
          content:
            'default':
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/whois"
                  meta:
                    type: object
                    properties:
      tags:
        - WHOIS

  /registrar/v1/whois/{name}/raw:
    parameters:
      - name: name
        in: path
        required: true
        description: The domain name
        schema:
          type: string

    get:
      description: Retrieve the raw WHOIS record for an individual domain
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    description: A plain text string containing the raw WHOIS result
                    type: string
                  meta:
                    type: object
                    properties:
      tags:
        - WHOIS

components:
  securitySchemes:
    api_key:
      type: apiKey
      description: API key authentication
      in: header
      name: Authorization

  schemas:

    domain:
      properties:
        id:
          description: A unique identifier for the domain name
          type: integer
        client_id:
          description: The ID of the client this resource is assigned to
          type: integer
        name:
          description: The domain name
          type: string
        status:
          description: The domain registration status
          type: string
        registrar:
          description: The registrar where the domain is registered
          type: string
        registered_at:
          description: Date the domain was registered, returned in UTC timezone, formatted in ISO 8601
          type: string
        updated_at:
          description: Date the domain was last updated, returned in UTC timezone, formatted in ISO 8601
          type: string
        renewal_at:
          description: Date the domain is due for renewal, returned in UTC timezone, formatted in ISO 8601
          type: string
        auto_renew:
          description: Is auto-renew enabled on the domain
          type: boolean
        whois_privacy:
          description: Is whois-privacy enabled on the domain
          type: boolean

    whois:
      properties:
        name:
          description: The domain name
          type: string
        status:
          description: The domain registration status
          type: array
          items:
            type: string
        created_at:
          description: Date the domain was registered, returned in UTC timezone, formatted in ISO 8601
          type: string
        updated_at:
          description: Date the domain was last updated, returned in UTC timezone, formatted in ISO 8601
          type: string
        expires_at:
          description: Date the domain is due to expire, returned in UTC timezone, formatted in ISO 8601
          type: string
        nameservers:
          description: The domain's registered nameservers
          type: array
          items:
            properties:
              host:
                description: Hostname of the assigned nameserver
                type: string
              ip:
                description: IP of the assigned nameserver
                type: string
        registrar:
          description: The registrar where the domain is registered
          type: array
          items:
            properties:
              name:
                description: The registrar name
                type: string
              url:
                description: The registered url of the registrar
                type: string
              iana_id:
                description: The IANA registration ID of the registrar
                type: integer