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

# Create an OVH cluster



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/clusters/ovh
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
paths:
  /api/v1/clusters/ovh:
    post:
      tags:
        - OVH Cluster API
      summary: Create an OVH cluster
      operationId: create_ovh_cluster_endpoint_api_v1_clusters_ovh_post
      parameters:
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOvhClusterRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOvhClusterResponse'
          description: Cluster created successfully
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    CreateOvhClusterRequest:
      properties:
        availability_zones:
          title: Availability Zones
          type: array
          items:
            type: string
          description: >-
            3-AZ regions only: spread the cluster across these availability
            zones (e.g. eu-west-par-a/b/c). Control planes and etcd are
            distributed per role, workers per node group. Omitted leaves
            placement to OVH, which places the whole cluster in one zone. More
            than one zone requires at least 3 control planes for etcd quorum.
        cni:
          default: flannel
          enum:
            - flannel
            - calico
            - cilium
          title: Cni
          type: string
        control_plane_count:
          default: 1
          title: Control Plane Count
          type: integer
        control_plane_flavor_id:
          default: b3-16
          title: Control Plane Flavor Id
          type: string
        credential_id:
          format: uuid4
          title: Credential Id
          type: string
        criticality:
          anyOf:
            - enum:
                - production
                - staging
                - development
                - disposable
              type: string
            - type: 'null'
          title: Criticality
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        dhcp_end:
          default: 10.0.1.200
          title: Dhcp End
          type: string
        dhcp_start:
          default: 10.0.1.100
          title: Dhcp Start
          type: string
        distribution:
          default: k3s
          title: Distribution
          type: string
        environment:
          anyOf:
            - maxLength: 50
              minLength: 1
              type: string
            - type: 'null'
          title: Environment
        etcd_flavor_id:
          default: b3-16
          title: Etcd Flavor Id
          type: string
        etcd_node_count:
          default: 3
          title: Etcd Node Count
          type: integer
        etcd_topology:
          default: stacked
          title: Etcd Topology
          type: string
        external_cloud_provider:
          default: true
          title: External Cloud Provider
          type: boolean
        gateway_flavor_id:
          default: c3-4
          title: Gateway Flavor Id
          type: string
        gitops_branch:
          default: master
          title: Gitops Branch
          type: string
        gitops_credential_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Gitops Credential Name
        gitops_repository:
          anyOf:
            - type: string
            - type: 'null'
          title: Gitops Repository
        include_networking:
          default: true
          title: Include Networking
          type: boolean
        kubernetes_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Kubernetes Version
        name:
          title: Name
          type: string
        network_vlan_id:
          default: 0
          title: Network Vlan Id
          type: integer
        node_groups:
          anyOf:
            - items:
                $ref: '#/components/schemas/CreateOvhNodeGroupRequest'
              type: array
            - type: 'null'
          title: Node Groups
        region:
          title: Region
          type: string
        ssh_key_credential_id:
          format: uuid4
          title: Ssh Key Credential Id
          type: string
        subnet_cidr:
          default: 10.0.1.0/24
          title: Subnet Cidr
          type: string
        worker_count:
          default: 1
          title: Worker Count
          type: integer
        worker_flavor_id:
          default: b3-16
          title: Worker Flavor Id
          type: string
      required:
        - name
        - credential_id
        - ssh_key_credential_id
        - region
      title: CreateOvhClusterRequest
      type: object
    CreateOvhClusterResponse:
      properties:
        cluster_id:
          format: uuid4
          title: Cluster Id
          type: string
        name:
          title: Name
          type: string
      required:
        - cluster_id
        - name
      title: CreateOvhClusterResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CreateOvhNodeGroupRequest:
      properties:
        availability_zone:
          title: Availability Zone
          type: string
          description: >-
            OVH 3-AZ regions only: pin every node of this group to one
            availability zone (e.g. eu-west-par-b). Omitted spreads the group
            across the cluster's zones.
        count:
          default: 1
          title: Count
          type: integer
        instance_type:
          title: Instance Type
          type: string
        labels:
          additionalProperties:
            type: string
          title: Labels
          type: object
        name:
          title: Name
          type: string
        taints:
          items:
            $ref: '#/components/schemas/NodeTaint'
          title: Taints
          type: array
        user_data:
          title: User Data
          type: string
          description: >-
            OVH only: opaque cloud-init user data applied verbatim at first boot
            by every instance the group ever creates, replacements included. Max
            65535 bytes.
      required:
        - name
        - instance_type
      title: CreateOvhNodeGroupRequest
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    NodeTaint:
      properties:
        effect:
          enum:
            - NoSchedule
            - PreferNoSchedule
            - NoExecute
          title: Effect
          type: string
        key:
          title: Key
          type: string
        value:
          default: ''
          title: Value
          type: string
      required:
        - key
        - effect
      title: NodeTaint
      type: object

````