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

# Create project

> Projects — group of namespaces / VMs / guest clusters with shared

**Authorisation:** `project:Create` on `krn:celum:supervisor:{name}:project:*`.

**Assistant tool:** `create_project`



## OpenAPI

````yaml /openapi.json post /api/supervisors/{name}/projects
openapi: 3.0.3
info:
  description: >-
    The HTTP surface of the Celum backend, generated from its own router and

    authorisation map — so this list cannot drift from the server that serves
    it.


    **Every operation states the IAM action and resource it is authorised

    against.** That pairing is the part worth reading: a policy naming the right

    action against the wrong resource matches nothing, and fails silently.


    Request and response bodies come from the Go types the handlers send and

    decode. Where those types do not determine the shape (an interface, a

    map[string]any, an unknown custom encoding), the operation says so in

    `x-celum-schema-gap` instead of carrying a guessed schema.
  title: Celum API
  version: 1.0.0
servers:
  - description: Your Celum deployment
    url: https://{host}
    variables:
      host:
        default: celum.example.com
        description: The host your Celum backend is served from
security:
  - sessionCookie: []
  - bearerToken: []
tags:
  - description: AI assistant & MCP
    name: ai-assistant
  - description: Clusters & CAPI lifecycle
    name: capi
  - description: Certificates & external secrets
    name: certs
  - description: GitOps & apps
    name: gitops
  - description: IAM, audit & auth
    name: iam
  - description: Image library
    name: images
  - description: Infrastructure & supervisors
    name: infrastructure
  - description: Networking
    name: networking
  - description: Observability & platform health
    name: observability
  - description: Platform onboarding & settings
    name: platform-settings
  - description: Projects
    name: projects
  - description: Registries & mirroring
    name: registries
  - description: Security & flows
    name: security
  - description: Storage
    name: storage
  - description: Templates & addons
    name: templates
  - description: Virtualization platform (KubeVirt/CDI)
    name: virt
  - description: Virtual machines
    name: vms
  - description: Workloads & topology
    name: workloads
paths:
  /api/supervisors/{name}/projects:
    post:
      tags:
        - projects
      summary: Create project
      description: >-
        Projects — group of namespaces / VMs / guest clusters with shared


        **Authorisation:** `project:Create` on
        `krn:celum:supervisor:{name}:project:*`.


        **Assistant tool:** `create_project`
      operationId: post_supervisors_byName_projects
      parameters:
        - description: >-
            The supervisor's name, as registered under Administration →
            Supervisors.
          in: path
          name: name
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.projectCreateRequest.Input'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.projectWriteResponse'
          description: Created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Request.
        '401':
          description: Not authenticated — no valid session cookie or API token.
        '403':
          description: >-
            Authenticated, but no policy allows this action on this resource.
            The body carries the action and resource that were evaluated.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Conflict.
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Precondition Failed.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Internal Server Error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Gateway.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Service Unavailable.
components:
  schemas:
    api.projectCreateRequest.Input:
      properties:
        bgpAdvertise:
          allOf:
            - $ref: '#/components/schemas/k8s.BgpAdvertiseSelection.Input'
          nullable: true
          type: object
        dedicatedGateway:
          nullable: true
          type: boolean
        defaultIsolationPolicy:
          nullable: true
          type: boolean
        description:
          type: string
        egressIp:
          type: string
        egressNodeCount:
          format: int64
          type: integer
        egressOverrideCIDR:
          type: string
        egressRouting:
          type: string
        kamajiCPAccess:
          nullable: true
          type: boolean
        labels:
          additionalProperties:
            type: string
          nullable: true
          type: object
        lbCidr:
          type: string
        name:
          type: string
        observabilityEgress:
          nullable: true
          type: boolean
        outsidePlan:
          type: boolean
        podCidr:
          type: string
        vmIdentityCidr:
          type: string
      type: object
      x-go-type: backend/internal/api.projectCreateRequest
    api.projectWriteResponse:
      properties:
        bgpAdvertise:
          $ref: '#/components/schemas/k8s.BgpAdvertiseSelection'
        createdAt:
          format: date-time
          type: string
        createdBy:
          type: string
        dedicatedGateway:
          type: boolean
        dedicatedGatewayStatus:
          $ref: '#/components/schemas/k8s.DedicatedGatewayStatus'
        defaultIsolationPolicy:
          type: boolean
        deleting:
          type: boolean
        description:
          type: string
        egressIp:
          type: string
        egressIps:
          items:
            type: string
          type: array
        egressNodes:
          items:
            $ref: '#/components/schemas/k8s.EgressNodeAlloc'
          type: array
        egressRouting:
          type: string
        isolationPolicyPresent:
          type: boolean
        kamajiCPAccess:
          type: boolean
        kamajiPolicyPresent:
          type: boolean
        labels:
          additionalProperties:
            type: string
          nullable: true
          type: object
        lbCidr:
          type: string
        name:
          type: string
        namespace:
          type: string
        observabilityEgress:
          type: boolean
        podCidr:
          type: string
        podMaskSize:
          format: int64
          type: integer
        supervisorName:
          type: string
        vmIdentityCidr:
          type: string
        warnings:
          items:
            type: string
          type: array
      required:
        - bgpAdvertise
        - createdAt
        - createdBy
        - dedicatedGateway
        - defaultIsolationPolicy
        - description
        - egressIp
        - isolationPolicyPresent
        - kamajiCPAccess
        - kamajiPolicyPresent
        - labels
        - lbCidr
        - name
        - namespace
        - observabilityEgress
        - podCidr
        - podMaskSize
        - supervisorName
        - vmIdentityCidr
      type: object
      x-go-type: backend/internal/api.projectWriteResponse
    api.ErrorBody:
      properties:
        error:
          type: string
      required:
        - error
      type: object
    k8s.BgpAdvertiseSelection.Input:
      properties:
        egress:
          type: string
        lb:
          type: string
        pod:
          type: string
      type: object
      x-go-type: backend/internal/k8s.BgpAdvertiseSelection
    k8s.BgpAdvertiseSelection:
      properties:
        egress:
          type: string
        lb:
          type: string
        pod:
          type: string
      type: object
      x-go-type: backend/internal/k8s.BgpAdvertiseSelection
    k8s.DedicatedGatewayStatus:
      properties:
        gateway:
          type: string
        message:
          type: string
        present:
          type: boolean
        programmed:
          type: boolean
        proxiesReady:
          type: string
        routes:
          format: int64
          type: integer
        vip:
          type: string
      required:
        - gateway
        - present
        - programmed
        - routes
      type: object
      x-go-type: backend/internal/k8s.DedicatedGatewayStatus
    k8s.EgressNodeAlloc:
      properties:
        ip:
          type: string
        node:
          type: string
      required:
        - ip
        - node
      type: object
      x-go-type: backend/internal/k8s.EgressNodeAlloc
  securitySchemes:
    sessionCookie:
      description: >-
        The session cookie issued by the OIDC sign-in flow. This is what a
        browser uses.
      in: cookie
      name: k8s-gate-session
      type: apiKey
    bearerToken:
      description: >-
        An API token, minted from your own identity page. A token carries the
        IAM groups you held **when it was minted**, and cannot bypass deletion
        approval — except for guest clusters inside a project that same token
        created.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.