> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.atom.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create URL forward

> Create a new URL forwarding rule for a domain. Supports permanent (301) and temporary (302) redirects.



## OpenAPI

````yaml POST /registrar/v1/domains/{domain_name}/url-forwards
openapi: 3.0.0
info:
  title: Atom Registrar API
  version: 1.0.0
  description: >-
    REST API for domain registration, DNS management, and domain operations.
    Authentication via Bearer token in Authorization header.
servers:
  - url: https://www.atom.com/api
    description: Production server
  - url: https://dev.atom.com/api
    description: Development server
security:
  - BearerAuth: []
paths:
  /registrar/v1/domains/{domain_name}/url-forwards:
    post:
      summary: Create URL forward
      description: >-
        Create a new URL forwarding rule for a domain. Supports permanent (301)
        and temporary (302) redirects.
      parameters:
        - name: domain_name
          in: path
          description: Domain name (e.g., 'example.com')
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UrlForwardCreateRequest'
      responses:
        '201':
          description: URL forward created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UrlForwardResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    UrlForwardCreateRequest:
      type: object
      required:
        - destination
      properties:
        source:
          type: string
          description: Source subdomain (empty for root domain)
          example: www
        destination:
          type: string
          example: https://www.example.com
          description: Full destination URL
        type:
          type: string
          enum:
            - permanent
            - temporary
          default: temporary
          example: permanent
          description: 'Redirect type: ''permanent'' (301) or ''temporary'' (302)'
    UrlForwardResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: URL forward created successfully
        data:
          $ref: '#/components/schemas/UrlForward'
    UrlForward:
      type: object
      properties:
        id:
          type: integer
          example: 456
        source:
          type: string
          example: www
        destination:
          type: string
          example: https://www.example.com
        type:
          type: string
          enum:
            - permanent
            - temporary
          example: permanent
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: Invalid input provided
  responses:
    BadRequest:
      description: Bad request - invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    UnauthorizedError:
      description: Authentication failed - invalid or revoked API token
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              error:
                type: string
                example: Unauthorized
              message:
                type: string
                example: >-
                  Invalid registrar API token or access has been revoked. Please
                  request registrar API access from your dashboard.
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Registrar API Bearer token. Obtain from dashboard at
        /dashboard/seller/api-access after requesting Registrar API access.

````