Incus projects API is one of 22 APIs that Incus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include projects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.
This API exposes
10 operations
across 5 paths,
and defines 10 schemas.
It is described by OpenAPI 2.0, at version 1.0.
10 operations5 paths10 schemas1 DELETE5 GET1 PATCH2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Across 5 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
projects 10
GET
/1.0/projects
Get the projects
projects_get1 param→ 200403500
POST
/1.0/projects
Add a project
projects_post1 param→ 200400403500
DELETE
/1.0/projects/{name}
Delete the project
project_delete2 params→ 200400403500
GET
/1.0/projects/{name}
Get the project
project_get1 param→ 200403500
PATCH
/1.0/projects/{name}
Partially update the project
project_patch2 params→ 200400403412500
POST
/1.0/projects/{name}
Rename the project
project_post2 params→ 202400403500
PUT
/1.0/projects/{name}
Update the project
project_put2 params→ 200400403412500
GET
/1.0/projects/{name}/access
Get who has access to a project
project_access1 param→ 200400403500
GET
/1.0/projects/{name}/state
Get the project state
project_state_get1 param→ 200403500
GET
/1.0/projects?recursion=1
Get the projects
projects_get_recursion11 param→ 200403500
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Operation (12 properties), Project (4 properties), AccessEntry (3 properties), ProjectsPost (3 properties). Each schema is shown below with its type and property counts.
Operation
object
Operation represents a background operation
12 properties
ProjectPut
object
ProjectPut represents the modifiable fields of a project
2 properties
StatusCode
integer
Access
array
AccessEntry
object
3 properties
ProjectsPost
object
ProjectsPost represents the fields of a new project
3 properties
ProjectPost
object
ProjectPost represents the fields required to rename a project
1 property
ProjectStateResource
object
ProjectStateResource represents the state of a particular resource in a project
2 properties
ProjectState
object
ProjectState represents the current running state of a project
1 property
Project
object
Project represents a project
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
