Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Incus profiles API

The profiles API from Incus — 3 operation(s) for profiles.

Incus profiles API is one of 22 APIs that Incus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.

This API exposes 8 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 1.0.

8 operations 3 paths 4 schemas 1 DELETE3 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
License
Resource Areas
1

Paths & Operations 8

Across 3 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

profiles 8
GET
/1.0/profiles
Get the profiles
profiles_get 3 params → 200403500
POST
/1.0/profiles
Add a profile
profiles_post 2 params → 200400403500
DELETE
/1.0/profiles/{name}
Delete the profile
profile_delete 2 params → 200400403500
GET
/1.0/profiles/{name}
Get the profile
profile_get 2 params → 200403500
PATCH
/1.0/profiles/{name}
Partially update the profile
profile_patch 3 params → 200400403412500
POST
/1.0/profiles/{name}
Rename the profile
profile_post 3 params → 200400403500
PUT
/1.0/profiles/{name}
Update the profile
profile_put 3 params → 200400403412500
GET
/1.0/profiles?recursion=1
Get the profiles
profiles_get_recursion1 3 params → 200403500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Profile (6 properties), ProfilesPost (4 properties), ProfilePut (3 properties), ProfilePost (1 property). Each schema is shown below with its type and property counts.

ProfilesPost
object
ProfilesPost represents the fields of a new profile
4 properties
ProfilePost
object
ProfilePost represents the fields required to rename a profile
1 property
ProfilePut
object
ProfilePut represents the modifiable fields of a profile
3 properties
Profile
object
Profile represents a profile
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-profiles-api-openapi.yml Raw ↑

Other APIs Incus publishes across the network.

Incus certificates API
Incus cluster API
Incus cluster-groups API
Incus images API
Incus instances API
Incus Metadata API
Incus metrics API
Incus network-acls API
Incus network-address-sets API
Incus network-allocations API
Incus network-forwards API
Incus network-integrations API