openapi: 3.2.0
info:
  title: 10Web API V1 Subdomain API
  description: The 10Web API provides a comprehensive set of endpoints for managing websites, DNS zones, domains, SSL certificates, backups, and more. This RESTful API allows you to integrate 10Web's powerful hosting and website management capabilities into your own applications.
servers:
- url: https://api.10web.io
tags:
- name: Sub Domain
  description: Operations for subdomain management
paths:
  /v1/hosting/websites/subdomain/check:
    post:
      summary: Check if a subdomain is available
      tags:
      - Sub Domain
      parameters:
      - $ref: '#/components/parameters/Authorization'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - subdomain
              properties:
                subdomain:
                  type: string
                  description: The subdomain to check for availability (max 63 chars)
                  example: my-website
      responses:
        '200':
          description: Subdomain availability check result
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                    - error
                  message:
                    type: string
                    description: Status message about the subdomain
                example:
                  status: ok
                  message: Subdomain is free
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      operationId: postV1HostingWebsitesSubdomainCheck
      x-operation-id-source: derived
  /v1/hosting/websites/subdomain/generate:
    post:
      summary: Generate a random available subdomain
      tags:
      - Sub Domain
      parameters:
      - $ref: '#/components/parameters/Authorization'
      responses:
        '200':
          description: Generated subdomain result
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                    - error
                  subdomain:
                    type: string
                    description: The generated subdomain
                example:
                  status: ok
                  subdomain: summary-starfish
        '403':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      operationId: postV1HostingWebsitesSubdomainGenerate
      x-operation-id-source: derived
components:
  responses:
    TooManyRequests:
      description: Too many requests
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                - error
              message:
                type: string
                example: Too many requests. Please try again later.
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                - error
              message:
                type: string
                example: Invalid request parameters
    Unauthorized:
      description: Unauthorized access
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                - error
              message:
                type: string
                example: Unauthorized access
    InternalServerError:
      description: Something went wrong
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                - error
              message:
                type: string
                example: Something went wrong
  parameters:
    Authorization:
      name: x-api-key
      in: header
      required: true
      schema:
        type: string
      description: API key for authentication
      example: API_KEY