Canonical Network Peers API

The network-peers API from Canonical — 3 operation(s) for network-peers.

Documentation GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /1.0/networks/{networkName}/peers List URLs of a network's peerings · Get the network peers #

Ask an LLM

“Which peerings does an OVN network have, as links?”

“How do I get just the peer URLs for a network?”

Tell an agent

List peer URLs for the network I name in project {project}.

Give me links to every peering on this network.

POST /1.0/networks/{networkName}/peers Create a network peering · Add a network peer #

Ask an LLM

“How do I peer two LXD networks so they can route to each other?”

“Can I peer with a network that lives in another project?”

Tell an agent

Create peer {name} to network {target_network}.

Peer as {name} with {target_network} in project {target_project}.

DELETE /1.0/networks/{networkName}/peers/{peerName} Delete a network peering · Delete the network peer #

Ask an LLM

“How do I remove the peering between two networks?”

“Can I delete a peer from a network in a given project?”

Tell an agent destructive · confirm first

Delete the network peering I name.

Remove the peer from the network in project {project}.

GET /1.0/networks/{networkName}/peers/{peerName} Get one network peering · Get the network peer #

Ask an LLM

“What's the status of a specific network peering?”

“Can I look up one peer on a network by name?”

Tell an agent

Show the peering I name on this network.

Get one network peer's details in project {project}.

PATCH /1.0/networks/{networkName}/peers/{peerName} Change part of a peering's configuration · Partially update the network peer #

Ask an LLM

“Can I change just a peering's description?”

“Is there a partial update for network peers?”

Tell an agent

Patch only the peer's description to {description}.

Update just these peering config keys: {config}.

PUT /1.0/networks/{networkName}/peers/{peerName} Replace a peering's configuration · Update the network peer #

Ask an LLM

“How do I overwrite a peering's whole configuration?”

“Does a full peer update clear config keys I omit?”

Tell an agent

Replace the peering's entire config with {config}.

Rewrite the peer with description {description} and config {config}.

GET /1.0/networks/{networkName}/peers?recursion=1 List a network's peerings with full details · Get the network peers #

Ask an LLM

“Can I see every peering's target network and status in one call?”

“What config does each peer on my network have?”

Tell an agent

Fetch all peers of the network with full details in project {project}.

Show every peering's target and config, not just URLs.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/canonical:canonical-network-peers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    email: lxd@lists.canonical.com
    name: LXD upstream
    url: https://github.com/canonical/lxd
  description: 'This is the REST API used by all LXD clients.

    Internal endpoints aren''t included in this documentation.


    The LXD 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.'
  license:
    name: AGPL-3.0-only
    url: https://www.gnu.org/licenses/agpl-3.0.en.html
  title: LXD external REST Network Peers API
  version: '1.0'
tags:
- name: network-peers
paths:
  /1.0/networks/{networkName}/peers:
    get:
      description: Returns a list of network peers (URLs).
      operationId: network_peers_get
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '200':
          description: API endpoints
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    description: List of endpoints
                    example: "[\n  \"/1.0/networks/lxdbr0/peers/my-peer-1\",\n  \"/1.0/networks/lxdbr0/peers/my-peer-2\"\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: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get the network peers
      tags:
      - network-peers
    post:
      description: Initiates/creates a new network peering.
      operationId: network_peers_post
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '202':
          $ref: '#/components/responses/Operation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Add a network peer
      tags:
      - network-peers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkPeersPost'
        description: Peer
        required: true
  /1.0/networks/{networkName}/peers/{peerName}:
    delete:
      description: Removes the network peering.
      operationId: network_peer_delete
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '202':
          $ref: '#/components/responses/Operation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Delete the network peer
      tags:
      - network-peers
    get:
      description: Gets a specific network peering.
      operationId: network_peer_get
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '200':
          description: Peer
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    $ref: '#/components/schemas/NetworkPeer'
                  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: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get the network peer
      tags:
      - network-peers
    patch:
      description: Updates a subset of the network peering configuration.
      operationId: network_peer_patch
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '202':
          $ref: '#/components/responses/Operation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Partially update the network peer
      tags:
      - network-peers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkPeerPut'
        description: Peer configuration
        required: true
    put:
      description: Updates the entire network peering configuration.
      operationId: network_peer_put
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '202':
          $ref: '#/components/responses/Operation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Update the network peer
      tags:
      - network-peers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkPeerPut'
        description: Peer configuration
        required: true
  /1.0/networks/{networkName}/peers?recursion=1:
    get:
      description: Returns a list of network peers (structs).
      operationId: network_peer_get_recursion1
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '200':
          description: API endpoints
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    description: List of network peers
                    items:
                      $ref: '#/components/schemas/NetworkPeer'
                    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: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get the network peers
      tags:
      - network-peers
components:
  schemas:
    Operation:
      description: Operation represents a LXD background operation
      properties:
        child_count:
          description: 'Number of child operations.


            API extension: operation_child_count'
          example: 2
          format: int64
          type: integer
          x-go-name: ChildCount
        class:
          description: Type of operation (task, token or websocket)
          example: websocket
          type: string
          x-go-name: Class
        created_at:
          description: Operation creation time
          example: '2021-03-23T17:38:37.753398689-04:00'
          format: date-time
          type: string
          x-go-name: CreatedAt
        description:
          description: Description of the operation
          example: Executing command
          type: string
          x-go-name: Description
        err:
          description: Operation error message
          example: Some error message
          type: string
          x-go-name: Err
        err_code:
          description: 'Operation error code


            API extension: bulk_operations'
          example: 404
          format: int64
          type: integer
          x-go-name: ErrCode
        id:
          description: UUID of the operation
          example: 6916c8a6-9b7d-4abd-90b3-aedfec7ec7da
          type: string
          x-go-name: ID
        location:
          description: 'Which cluster member this record was found on


            API extension: operation_location'
          example: lxd01
          type: string
          x-go-name: Location
        may_cancel:
          description: Whether the operation can be canceled
          example: false
          type: boolean
          x-go-name: MayCancel
        metadata:
          additionalProperties: {}
          description: Operation specific metadata
          example:
            command:
            - bash
            environment:
              HOME: /root
              LANG: C.UTF-8
              PATH: /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
              TERM: xterm
              USER: root
            fds:
              '0': da3046cf02c0116febf4ef3fe4eaecdf308e720c05e5a9c730ce1a6f15417f66
              '1': 05896879d8692607bd6e4a09475667da3b5f6714418ab0ee0e5720b4c57f754b
            interactive: true
          type: object
          x-go-name: Metadata
        requestor:
          $ref: '#/components/schemas/OperationRequestor'
        resources:
          additionalProperties:
            items:
              type: string
            type: array
          description: Affected resources
          example:
            instances:
            - /1.0/instances/foo
            - /1.0/instances/bar
          type: object
          x-go-name: Resources
        status:
          description: Status name
          example: Running
          type: string
          x-go-name: Status
        status_code:
          $ref: '#/components/schemas/StatusCode'
        updated_at:
          description: Operation last change
          example: '2021-03-23T17:38:37.753398689-04:00'
          format: date-time
          type: string
          x-go-name: UpdatedAt
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    NetworkPeersPost:
      description: NetworkPeersPost represents the fields of a new LXD network peering
      properties:
        config:
          additionalProperties:
            type: string
          description: Peer configuration map (refer to doc/network-peers.md)
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the peer
          example: Peering with network1 in project1
          type: string
          x-go-name: Description
        name:
          description: Name of the peer
          example: project1-network1
          type: string
          x-go-name: Name
        target_network:
          description: Name of the target network
          example: network1
          type: string
          x-go-name: TargetNetwork
        target_project:
          description: Name of the target project
          example: project1
          type: string
          x-go-name: TargetProject
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    NetworkPeer:
      properties:
        config:
          additionalProperties:
            type: string
          description: Peer configuration map (refer to doc/network-peers.md)
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the peer
          example: Peering with network1 in project1
          type: string
          x-go-name: Description
        name:
          description: Name of the peer
          example: project1-network1
          readOnly: true
          type: string
          x-go-name: Name
        status:
          description: The state of the peering
          example: Pending
          readOnly: true
          type: string
          x-go-name: Status
        target_network:
          description: Name of the target network
          example: network1
          readOnly: true
          type: string
          x-go-name: TargetNetwork
        target_project:
          description: Name of the target project
          example: project1
          readOnly: true
          type: string
          x-go-name: TargetProject
        used_by:
          description: List of URLs of objects using this network peering
          example:
          - /1.0/network-acls/test
          - /1.0/network-acls/foo
          items:
            type: string
          readOnly: true
          type: array
          x-go-name: UsedBy
      title: NetworkPeer used for displaying a LXD network peering.
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    StatusCode:
      format: int64
      title: StatusCode represents a valid LXD operation and container status.
      type: integer
      x-go-package: github.com/canonical/lxd/shared/api
    OperationRequestor:
      description: 'API extension: operation_requestor.'
      properties:
        address:
          description: Address is the origin address of the request.
          example: 10.0.2.15
          type: string
          x-go-name: Address
        protocol:
          description: Protocol represents the method used to authenticate the requestor.
          example: oidc
          type: string
          x-go-name: Protocol
        username:
          description: Username is the username of the requestor. This is the identifier of the identity, or the username if using the unix socket.
          example: jane.doe@example.com
          type: string
          x-go-name: Username
      title: OperationRequestor represents the initial requestor of an operation
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    NetworkPeerPut:
      description: NetworkPeerPut represents the modifiable fields of a LXD network peering
      properties:
        config:
          additionalProperties:
            type: string
          description: Peer configuration map (refer to doc/network-peers.md)
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the peer
          example: Peering with network1 in project1
          type: string
          x-go-name: Description
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          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
    Operation:
      description: Operation
      content:
        application/json:
          schema:
            properties:
              metadata:
                $ref: '#/components/schemas/Operation'
              operation:
                example: /1.0/operations/66e83638-9dd7-4a26-aef2-5462814869a1
                type: string
                x-go-name: Operation
              status:
                example: Operation created
                type: string
                x-go-name: Status
              status_code:
                example: 100
                format: int64
                type: integer
                x-go-name: StatusCode
              type:
                example: async
                type: string
                x-go-name: Type
            type: object
    Forbidden:
      description: Forbidden
      content:
        application/json:
          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
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          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
    PreconditionFailed:
      description: Precondition Failed
      content:
        application/json:
          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

Canonical Network Peers API

Operations 7

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification