# Allocate Domains to DNS Shield

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/dns-shield/allocate-domains:
    post:
      summary: Allocate Domains to DNS Shield
      deprecated: false
      description: >-
        Allocate domains to your DNS Shield LTD subscription slots and enable
        DNS Shield protection. This endpoint assigns specific domains to your
        available LTD plan capacity and automatically configures DNS Shield
        protection.
      tags:
        - dns shield
      parameters:
        - name: x-auth-zapmail
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: x-workspace-key
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
        - name: x-service-provider
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                domainIds:
                  type: array
                  items:
                    type: string
              required:
                - domainIds
              x-apidog-orders:
                - domainIds
            example:
              domainIds:
                - ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      allocated:
                        type: integer
                      remaining:
                        type: integer
                      allocations:
                        type: array
                        items:
                          type: object
                          properties:
                            domainId:
                              type: string
                            subscriptionId:
                              type: string
                          required:
                            - domainId
                            - subscriptionId
                          x-apidog-orders:
                            - domainId
                            - subscriptionId
                      errors:
                        type: array
                        items:
                          type: string
                    required:
                      - success
                      - allocated
                      - remaining
                      - allocations
                      - errors
                    x-apidog-orders:
                      - success
                      - allocated
                      - remaining
                      - allocations
                      - errors
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Domains allocated to DNS Shield successfully
                data:
                  success: true
                  allocated: 25
                  remaining: 0
                  allocations:
                    - domainId: a66ccca7-d465-464a-887b-90bce6d09bbb
                      subscriptionId: sub-uuid-1
                    - domainId: b77dddb8-e576-575b-998c-01cdf7e10ccc
                      subscriptionId: sub-uuid-1
                    - domainId: c88eeeec9-f687-686c-aa9d-12def8f21ddd
                      subscriptionId: sub-uuid-2
                  errors: []
          headers: {}
          x-apidog-name: Success
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      errorId:
                        type: string
                    required:
                      - errorId
                    x-apidog-orders:
                      - errorId
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 400
                message: No domains found matching the criteria
                data:
                  errorId: unique-error-id
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      errorId:
                        type: string
                    required:
                      - errorId
                    x-apidog-orders:
                      - errorId
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 401
                message: Invalid API key
                data:
                  errorId: unique-error-id
          headers: {}
          x-apidog-name: Unauthorized
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      errorId:
                        type: string
                    required:
                      - errorId
                    x-apidog-orders:
                      - errorId
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 500
                message: Internal server error
                data:
                  errorId: unique-error-id
          headers: {}
          x-apidog-name: Internal Server Error
      security: []
      x-apidog-folder: dns shield
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-25781833-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```