The network-integrations API from Incus — 3 operation(s) for network-integrations.
swagger: '2.0'
info:
contact:
email: lxc-devel@lists.linuxcontainers.org
name: Incus upstream
url: https://github.com/lxc/incus
description: 'This is the REST API used by all Incus clients.
Internal endpoints aren''t included in this documentation.
The Incus API is available over both a local unix+http and remote https API.
Authentication for local users relies on group membership and access to the unix socket.
For remote users, the default authentication method is TLS client
certificates.'
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
title: Incus external REST certificates network-integrations API
version: '1.0'
tags:
- name: network-integrations
paths:
/1.0/network-integrations:
get:
description: Returns a list of network integrations (URLs).
operationId: network_integrations_get
parameters:
- description: Collection filter
example: default
in: query
name: filter
type: string
produces:
- application/json
responses:
'200':
description: API endpoints
schema:
description: Sync response
properties:
metadata:
description: List of endpoints
example: "[\n \"/1.0/network-integrations/region2\",\n \"/1.0/network-integrations/region3\"\n]"
items:
type: string
type: array
status:
description: Status description
example: Success
type: string
status_code:
description: Status code
example: 200
type: integer
type:
description: Response type
example: sync
type: string
type: object
'403':
$ref: '#/responses/Forbidden'
'500':
$ref: '#/responses/InternalServerError'
summary: Get the network integrations
tags:
- network-integrations
post:
consumes:
- application/json
description: Creates a new network integration.
operationId: network_integrations_post
parameters:
- description: integration
in: body
name: integration
required: true
schema:
$ref: '#/definitions/NetworkIntegrationsPost'
produces:
- application/json
responses:
'200':
$ref: '#/responses/EmptySyncResponse'
'400':
$ref: '#/responses/BadRequest'
'403':
$ref: '#/responses/Forbidden'
'500':
$ref: '#/responses/InternalServerError'
summary: Add a network integration
tags:
- network-integrations
/1.0/network-integrations/{integration}:
delete:
description: Removes the network integration.
operationId: network_integration_delete
parameters:
- description: Integration name
in: path
name: integration
required: true
type: string
produces:
- application/json
responses:
'200':
$ref: '#/responses/EmptySyncResponse'
'400':
$ref: '#/responses/BadRequest'
'403':
$ref: '#/responses/Forbidden'
'500':
$ref: '#/responses/InternalServerError'
summary: Delete the network integration
tags:
- network-integrations
get:
description: Gets a specific network integration.
operationId: network_integration_get
parameters:
- description: Integration name
in: path
name: integration
required: true
type: string
produces:
- application/json
responses:
'200':
description: integration
schema:
description: Sync response
properties:
metadata:
$ref: '#/definitions/NetworkIntegration'
status:
description: Status description
example: Success
type: string
status_code:
description: Status code
example: 200
type: integer
type:
description: Response type
example: sync
type: string
type: object
'403':
$ref: '#/responses/Forbidden'
'500':
$ref: '#/responses/InternalServerError'
summary: Get the network integration
tags:
- network-integrations
patch:
consumes:
- application/json
description: Updates a subset of the network integration configuration.
operationId: network_integration_patch
parameters:
- description: Integration name
in: path
name: integration
required: true
type: string
- description: integration configuration
in: body
name: integration
required: true
schema:
$ref: '#/definitions/NetworkIntegrationPut'
produces:
- application/json
responses:
'200':
$ref: '#/responses/EmptySyncResponse'
'400':
$ref: '#/responses/BadRequest'
'403':
$ref: '#/responses/Forbidden'
'412':
$ref: '#/responses/PreconditionFailed'
'500':
$ref: '#/responses/InternalServerError'
summary: Partially update the network integration
tags:
- network-integrations
post:
description: Renames the network integration.
operationId: network_integration_post
parameters:
- description: Integration name
in: path
name: integration
required: true
type: string
- description: integration configuration
in: body
name: integration
required: true
schema:
$ref: '#/definitions/NetworkIntegrationPost'
produces:
- application/json
responses:
'200':
$ref: '#/responses/EmptySyncResponse'
'400':
$ref: '#/responses/BadRequest'
'403':
$ref: '#/responses/Forbidden'
'500':
$ref: '#/responses/InternalServerError'
summary: Rename the network integration
tags:
- network-integrations
put:
consumes:
- application/json
description: Updates the entire network integration configuration.
operationId: network_integration_put
parameters:
- description: Integration name
in: path
name: integration
required: true
type: string
- description: integration configuration
in: body
name: integration
required: true
schema:
$ref: '#/definitions/NetworkIntegrationPut'
produces:
- application/json
responses:
'200':
$ref: '#/responses/EmptySyncResponse'
'400':
$ref: '#/responses/BadRequest'
'403':
$ref: '#/responses/Forbidden'
'412':
$ref: '#/responses/PreconditionFailed'
'500':
$ref: '#/responses/InternalServerError'
summary: Update the network integration
tags:
- network-integrations
/1.0/network-integrations?recursion=1:
get:
description: Returns a list of network integrations (structs).
operationId: network_integrations_get_recursion1
parameters:
- description: Collection filter
example: default
in: query
name: filter
type: string
produces:
- application/json
responses:
'200':
description: API endpoints
schema:
description: Sync response
properties:
metadata:
description: List of network integrations
items:
$ref: '#/definitions/NetworkIntegration'
type: array
status:
description: Status description
example: Success
type: string
status_code:
description: Status code
example: 200
type: integer
type:
description: Response type
example: sync
type: string
type: object
'403':
$ref: '#/responses/Forbidden'
'500':
$ref: '#/responses/InternalServerError'
summary: Get the network integrations
tags:
- network-integrations
definitions:
NetworkIntegrationPost:
description: NetworkIntegrationPost represents the fields required to rename a network integration
properties:
name:
description: The new name for the network integration
example: region2
type: string
x-go-name: Name
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
NetworkIntegration:
properties:
config:
description: Integration configuration map (refer to doc/network-integrations.md)
example:
user.mykey: foo
type: object
x-go-name: Config
description:
description: Description of the network integration
example: OVN interconnection for region1
type: string
x-go-name: Description
name:
description: The name of the integration
example: region1
type: string
x-go-name: Name
type:
description: The type of integration
example: ovn
type: string
x-go-name: Type
used_by:
description: List of URLs of objects using this network integration
example:
- /1.0/networks/foo
- /1.0/networks/bar
items:
type: string
readOnly: true
type: array
x-go-name: UsedBy
title: NetworkIntegration represents a network integration.
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
NetworkIntegrationPut:
description: NetworkIntegrationPut represents the modifiable fields of a network integration
properties:
config:
description: Integration configuration map (refer to doc/network-integrations.md)
example:
user.mykey: foo
type: object
x-go-name: Config
description:
description: Description of the network integration
example: OVN interconnection for region1
type: string
x-go-name: Description
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
NetworkIntegrationsPost:
description: NetworkIntegrationsPost represents the fields of a new network integration
properties:
config:
description: Integration configuration map (refer to doc/network-integrations.md)
example:
user.mykey: foo
type: object
x-go-name: Config
description:
description: Description of the network integration
example: OVN interconnection for region1
type: string
x-go-name: Description
name:
description: The name of the integration
example: region1
type: string
x-go-name: Name
type:
description: The type of integration
example: ovn
type: string
x-go-name: Type
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
responses:
Forbidden:
description: Forbidden
schema:
properties:
error:
example: not authorized
type: string
x-go-name: Error
error_code:
example: 403
format: int64
type: integer
x-go-name: ErrorCode
type:
example: error
type: string
x-go-name: Type
type: object
BadRequest:
description: Bad Request
schema:
properties:
error:
example: bad request
type: string
x-go-name: Error
error_code:
example: 400
format: int64
type: integer
x-go-name: ErrorCode
type:
example: error
type: string
x-go-name: Type
type: object
EmptySyncResponse:
description: Empty sync response
schema:
properties:
status:
example: Success
type: string
x-go-name: Status
status_code:
example: 200
format: int64
type: integer
x-go-name: StatusCode
type:
example: sync
type: string
x-go-name: Type
type: object
PreconditionFailed:
description: Precondition Failed
schema:
properties:
error:
example: precondition failed
type: string
x-go-name: Error
error_code:
example: 412
format: int64
type: integer
x-go-name: ErrorCode
type:
example: error
type: string
x-go-name: Type
type: object
InternalServerError:
description: Internal Server Error
schema:
properties:
error:
example: internal server error
type: string
x-go-name: Error
error_code:
example: 500
format: int64
type: integer
x-go-name: ErrorCode
type:
example: error
type: string
x-go-name: Type
type: object