Documentation
¶
Overview ¶
Operations Center API
Operations Center is the central overview of an Incus deployment. It acts as the registration point for all servers running IncusOS, handles update tracking and rollout, provisions new Incus clusters and keeps track of resources across all clusters.
The API is served over HTTPS. Every response is a JSON object carrying a "type" field, which is "sync" for the responses documented here and "error" for failures. The payload of a successful response is carried in "metadata".
Clients authenticate either with a TLS client certificate, which is negotiated at the transport level and therefore cannot be expressed in Swagger 2.0, or with an OIDC bearer token, which is described by the "oidc" security definition.
Schemes: https
BasePath: /
Version: 1.0
License: Apache-2.0 https://www.apache.org/licenses/LICENSE-2.0
Consumes:
- application/json
Produces:
- application/json
SecurityDefinitions:
oidc:
type: apiKey
name: Authorization
in: header
description: OIDC bearer token, sent as "Bearer <token>".
swagger:meta
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MiddlewareFunc ¶
type MiddlewareFunc func(next http.HandlerFunc) http.HandlerFunc
Source Files
¶
- access_handler.go
- api.go
- api_1.0.go
- api_image_incus.go
- api_image_incus_source.go
- api_internal.go
- api_inventory+filters.go
- api_inventory_gen.go
- api_inventory_image_gen.go
- api_inventory_instance_gen.go
- api_inventory_network_acl_gen.go
- api_inventory_network_address_set_gen.go
- api_inventory_network_forward_gen.go
- api_inventory_network_gen.go
- api_inventory_network_integration_gen.go
- api_inventory_network_load_balancer_gen.go
- api_inventory_network_peer_gen.go
- api_inventory_network_zone_gen.go
- api_inventory_profile_gen.go
- api_inventory_project_gen.go
- api_inventory_query.go
- api_inventory_query_helper_gen.go
- api_inventory_storage_bucket_gen.go
- api_inventory_storage_pool_gen.go
- api_inventory_storage_volume_gen.go
- api_provisioning_channel.go
- api_provisioning_cluster.go
- api_provisioning_cluster_template.go
- api_provisioning_server.go
- api_provisioning_token.go
- api_provisioning_update.go
- api_system.go
- api_warning.go
- api_well_known.go
- daemon.go
- doc.go
- http_logger.go
- oidc.go
- os_proxy.go
- patches.go
- router.go
- sql_dump.go
- swagger_responses.go
- ui.go
Directories