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

# Check Name Availability

> Check if a deployment name is available for the authenticated user.
Returns whether the name can be used and a reason if not.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/deployment/check-name
openapi: 3.1.0
info:
  title: Cycls Cloud API
  description: >

    ## Deploy serverless functions in seconds


    Cycls Cloud lets you deploy containerized functions to the cloud with a
    single command.


    ### Authentication


    All endpoints require authentication via:

    - **API Key**: Pass `X-API-Key` header

    - **JWT**: Pass `Authorization: Bearer <token>` header


    ### Quick Start


    ```bash

    curl -X POST https://api.cycls.ai/v1/deploy \
      -H "X-API-Key: your_api_key" \
      -F "function_name=hello" \
      -F "source=@source.tar.gz"
    ```
  contact:
    name: Cycls
    url: https://cycls.com/
  version: 1.0.0
servers: []
security: []
tags:
  - name: Deployments
    description: Deploy, list, and manage your services
  - name: Volumes
    description: Named storage, attached to deployments by mount path
  - name: Logs
    description: Fetch service logs
  - name: Billing
    description: Subscription and usage
paths:
  /v1/deployment/check-name:
    get:
      tags:
        - Deployments
      summary: Check Name Availability
      description: |-
        Check if a deployment name is available for the authenticated user.
        Returns whether the name can be used and a reason if not.
      operationId: check_name_v1_deployment_check_name_get
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
            title: Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameCheckResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '503':
          description: Service Unavailable
      security:
        - HTTPBearer: []
        - APIKeyHeader: []
components:
  schemas:
    NameCheckResponse:
      properties:
        available:
          type: boolean
          title: Available
          description: Whether the name can be used by the caller
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
          description: Reason if unavailable
      type: object
      required:
        - available
      title: NameCheckResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````