Incus external REST API — projects

naftiko: 1.0.0-alpha2
info:
  label: Incus external REST API — projects
  description: 'Incus external REST API — projects. 10 operations. Lead operation: Get the projects. Self-contained Naftiko
    capability covering one Incus business surface.'
  tags:
  - Incus
  - projects
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    INCUS_API_KEY: INCUS_API_KEY
capability:
  consumes:
  - type: http
    namespace: incus-projects
    baseUri: ''
    description: Incus external REST API — projects business capability. Self-contained, no shared references.
    resources:
    - name: 1.0-projects
      path: /1.0/projects
      operations:
      - name: projectsget
        method: GET
        description: Get the projects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Collection filter
      - name: projectspost
        method: POST
        description: Add a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: project
          in: body
          type: string
          description: Project
          required: true
    - name: 1.0-projects-name
      path: /1.0/projects/{name}
      operations:
      - name: projectdelete
        method: DELETE
        description: Delete the project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Project name
          required: true
        - name: force
          in: query
          type: boolean
          description: Delete project and related artifacts
      - name: projectget
        method: GET
        description: Get the project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Project name
          required: true
      - name: projectpatch
        method: PATCH
        description: Partially update the project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Project name
          required: true
        - name: project
          in: body
          type: string
          description: Project configuration
          required: true
      - name: projectpost
        method: POST
        description: Rename the project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Project name
          required: true
        - name: project
          in: body
          type: string
          description: Project rename request
          required: true
      - name: projectput
        method: PUT
        description: Update the project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Project name
          required: true
        - name: project
          in: body
          type: string
          description: Project configuration
          required: true
    - name: 1.0-projects-name-access
      path: /1.0/projects/{name}/access
      operations:
      - name: projectaccess
        method: GET
        description: Get who has access to a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Project name
          required: true
    - name: 1.0-projects-name-state
      path: /1.0/projects/{name}/state
      operations:
      - name: projectstateget
        method: GET
        description: Get the project state
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Project name
          required: true
    - name: 1.0-projects?recursion=1
      path: /1.0/projects?recursion=1
      operations:
      - name: projectsgetrecursion1
        method: GET
        description: Get the projects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Collection filter
  exposes:
  - type: rest
    namespace: incus-projects-rest
    port: 8080
    description: REST adapter for Incus external REST API — projects. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/1-0/projects
      name: 1-0-projects
      description: REST surface for 1.0-projects.
      operations:
      - method: GET
        name: projectsget
        description: Get the projects
        call: incus-projects.projectsget
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: projectspost
        description: Add a project
        call: incus-projects.projectspost
        with:
          project: rest.project
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/1-0/projects/{name}
      name: 1-0-projects-name
      description: REST surface for 1.0-projects-name.
      operations:
      - method: DELETE
        name: projectdelete
        description: Delete the project
        call: incus-projects.projectdelete
        with:
          name: rest.name
          force: rest.force
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: projectget
        description: Get the project
        call: incus-projects.projectget
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: projectpatch
        description: Partially update the project
        call: incus-projects.projectpatch
        with:
          name: rest.name
          project: rest.project
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: projectpost
        description: Rename the project
        call: incus-projects.projectpost
        with:
          name: rest.name
          project: rest.project
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: projectput
        description: Update the project
        call: incus-projects.projectput
        with:
          name: rest.name
          project: rest.project
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/1-0/projects/{name}/access
      name: 1-0-projects-name-access
      description: REST surface for 1.0-projects-name-access.
      operations:
      - method: GET
        name: projectaccess
        description: Get who has access to a project
        call: incus-projects.projectaccess
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/1-0/projects/{name}/state
      name: 1-0-projects-name-state
      description: REST surface for 1.0-projects-name-state.
      operations:
      - method: GET
        name: projectstateget
        description: Get the project state
        call: incus-projects.projectstateget
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/1-0/projects-recursion-1
      name: 1-0-projects-recursion-1
      description: REST surface for 1.0-projects?recursion=1.
      operations:
      - method: GET
        name: projectsgetrecursion1
        description: Get the projects
        call: incus-projects.projectsgetrecursion1
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: incus-projects-mcp
    port: 9090
    transport: http
    description: MCP adapter for Incus external REST API — projects. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-projects
      description: Get the projects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: incus-projects.projectsget
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: add-project
      description: Add a project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: incus-projects.projectspost
      with:
        project: tools.project
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-project
      description: Delete the project
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: incus-projects.projectdelete
      with:
        name: tools.name
        force: tools.force
      outputParameters:
      - type: object
        mapping: $.
    - name: get-project
      description: Get the project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: incus-projects.projectget
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: partially-update-project
      description: Partially update the project
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: incus-projects.projectpatch
      with:
        name: tools.name
        project: tools.project
      outputParameters:
      - type: object
        mapping: $.
    - name: rename-project
      description: Rename the project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: incus-projects.projectpost
      with:
        name: tools.name
        project: tools.project
      outputParameters:
      - type: object
        mapping: $.
    - name: update-project
      description: Update the project
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: incus-projects.projectput
      with:
        name: tools.name
        project: tools.project
      outputParameters:
      - type: object
        mapping: $.
    - name: get-who-has-access-project
      description: Get who has access to a project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: incus-projects.projectaccess
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-project-state
      description: Get the project state
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: incus-projects.projectstateget
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-projects-2
      description: Get the projects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: incus-projects.projectsgetrecursion1
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.