Canonical Network Zones API

The network-zones API from Canonical — 6 operation(s) for network-zones.

Documentation GitHub OpenAPI

Operations 14

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/network-zones List network zones as URLs · Get the network zones #

Ask an LLM

“Which DNS network zones are defined on my LXD server?”

“Can I list network zone URLs across all projects?”

Tell an agent

List the URLs of my network zones.

List network zone URLs in project {project}.

POST /1.0/network-zones Create a network zone · Add a network zone #

Ask an LLM

“How do I create a new DNS zone for my LXD networks?”

“Can I set config and a description when adding a network zone?”

Tell an agent

Create network zone {name}.

Add network zone {name} described as {description} with config {config}.

DELETE /1.0/network-zones/{zone} Delete a network zone · Delete the network zone #

Ask an LLM

“Can I remove a DNS network zone I no longer use?”

“Can I delete a network zone that belongs to another project?”

Tell an agent destructive · confirm first

Delete this network zone.

Remove the network zone from project {project}.

GET /1.0/network-zones/{zone} Get a network zone · Get the network zone #

Ask an LLM

“What configuration does a particular network zone have?”

“Where can I read one DNS zone's settings in a project?”

Tell an agent

Show this network zone's configuration.

Get the network zone details in project {project}.

PATCH /1.0/network-zones/{zone} Partially update a network zone · Partially update the network zone #

Ask an LLM

“Can I change only the description of a network zone?”

“How do I tweak one config key on a zone without resending all of it?”

Tell an agent

Patch just the network zone description to {description}.

Merge config keys {config} into the zone's existing settings.

PUT /1.0/network-zones/{zone} Replace a network zone's configuration · Update the network zone #

Ask an LLM

“How do I overwrite a network zone's entire config at once?”

“Will replacing a zone's config drop keys I leave out?”

Tell an agent

Replace the whole network zone config with {config}.

Overwrite the zone's config {config} and description {description}.

GET /1.0/network-zones/{zone}/records List records in a network zone as URLs · Get the network zone records #

Ask an LLM

“Which DNS records exist in one of my network zones?”

“Can I get record URLs for a zone in a given project?”

Tell an agent

List the record URLs in this network zone.

List zone record URLs in project {project}.

POST /1.0/network-zones/{zone}/records Add a DNS record to a network zone · Add a network zone record #

Ask an LLM

“How do I add a custom DNS record to an LXD network zone?”

“Can a new zone record hold several entries at once?”

Tell an agent

Add record {name} to the zone with entries {entries}.

Create zone record {name} described as {description}.

DELETE /1.0/network-zones/{zone}/records/{name} Delete a network zone record · Delete the network zone record #

Ask an LLM

“Is there a way to remove a DNS record from a network zone?”

“Does deleting a zone record leave the zone itself in place?”

Tell an agent destructive · confirm first

Delete this record from the network zone.

Remove the zone record in project {project}.

GET /1.0/network-zones/{zone}/records/{name} Get a network zone record · Get the network zone record #

Ask an LLM

“What entries does a single DNS record in my zone contain?”

“What config does one record in a network zone hold?”

Tell an agent

Show this network zone record and its entries.

Get the zone record details in project {project}.

PATCH /1.0/network-zones/{zone}/records/{name} Partially update a network zone record · Partially update the network zone record #

Ask an LLM

“Can I update just the description of one zone record?”

“How do I change a record's entries without resending its config?”

Tell an agent

Patch the zone record description to {description}.

Update only the record entries to {entries}.

PUT /1.0/network-zones/{zone}/records/{name} Replace a network zone record · Update the network zone record #

Ask an LLM

“How do I overwrite all entries of an existing zone record?”

“Can I replace a zone record's config and entries in one go?”

Tell an agent

Replace the zone record's entries with {entries}.

Overwrite the whole record with entries {entries} and config {config}.

GET /1.0/network-zones/{zone}/records?recursion=1 List network zone records with full details · Get the network zone records #

Ask an LLM

“How do I get every record in a zone along with its entries in one call?”

“Can I list full zone record objects instead of URLs?”

Tell an agent

List all records in this zone as full objects with entries.

Get expanded zone records for project {project}.

GET /1.0/network-zones?recursion=1 List network zones with full details · Get the network zones #

Ask an LLM

“Can I fetch every network zone with its config in a single request?”

“Can I see full network zone objects for all projects at once?”

Tell an agent

List all network zones as full objects with config.

Get expanded network zones for project {project}.

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-zones-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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 Zones API
  version: '1.0'
tags:
- name: network-zones
paths:
  /1.0/network-zones:
    get:
      description: Returns a list of network zones (URLs).
      operationId: network_zones_get
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      - description: Retrieve network zones from all projects
        example: true
        in: query
        name: all-projects
        schema:
          type: boolean
      responses:
        '200':
          description: API endpoints
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    description: List of endpoints
                    example: "[\n  \"/1.0/network-zones/example.net\",\n  \"/1.0/network-zones/example.com\"\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 zones
      tags:
      - network-zones
    post:
      description: Creates a new network zone.
      operationId: network_zones_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 zone
      tags:
      - network-zones
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkZonesPost'
        description: zone
        required: true
  /1.0/network-zones/{zone}:
    delete:
      description: Removes the network zone.
      operationId: network_zone_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'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Delete the network zone
      tags:
      - network-zones
    get:
      description: Gets a specific network zone.
      operationId: network_zone_get
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '200':
          description: zone
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    $ref: '#/components/schemas/NetworkZone'
                  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 zone
      tags:
      - network-zones
    patch:
      description: Updates a subset of the network zone configuration.
      operationId: network_zone_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'
        '404':
          $ref: '#/components/responses/NotFound'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Partially update the network zone
      tags:
      - network-zones
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkZonePut'
        description: zone configuration
        required: true
    put:
      description: Updates the entire network zone configuration.
      operationId: network_zone_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'
        '404':
          $ref: '#/components/responses/NotFound'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Update the network zone
      tags:
      - network-zones
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkZonePut'
        description: zone configuration
        required: true
  /1.0/network-zones/{zone}/records:
    get:
      description: Returns a list of network zone records (URLs).
      operationId: network_zone_records_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/network-zones/example.net/records/foo\",\n  \"/1.0/network-zones/example.net/records/bar\"\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 zone records
      tags:
      - network-zones
    post:
      description: Creates a new network zone record.
      operationId: network_zone_records_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 zone record
      tags:
      - network-zones
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkZoneRecordsPost'
        description: zone
        required: true
  /1.0/network-zones/{zone}/records/{name}:
    delete:
      description: Removes the network zone record.
      operationId: network_zone_record_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'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Delete the network zone record
      tags:
      - network-zones
    get:
      description: Gets a specific network zone record.
      operationId: network_zone_record_get
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '200':
          description: zone
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    $ref: '#/components/schemas/NetworkZoneRecord'
                  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 zone record
      tags:
      - network-zones
    patch:
      description: Updates a subset of the network zone record configuration.
      operationId: network_zone_record_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'
        '404':
          $ref: '#/components/responses/NotFound'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Partially update the network zone record
      tags:
      - network-zones
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkZoneRecordPut'
        description: zone record configuration
        required: true
    put:
      description: Updates the entire network zone record configuration.
      operationId: network_zone_record_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'
        '404':
          $ref: '#/components/responses/NotFound'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Update the network zone record
      tags:
      - network-zones
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkZoneRecordPut'
        description: zone record configuration
        required: true
  /1.0/network-zones/{zone}/records?recursion=1:
    get:
      description: Returns a list of network zone records (structs).
      operationId: network_zone_records_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 zone records
                    items:
                      $ref: '#/components/schemas/NetworkZoneRecord'
                    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 zone records
      tags:
      - network-zones
  /1.0/network-zones?recursion=1:
    get:
      description: Returns a list of network zones (structs).
      operationId: network_zones_get_recursion1
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      - description: Retrieve network zones from all projects
        example: true
        in: query
        name: all-projects
        schema:
          type: boolean
      responses:
        '200':
          description: API endpoints
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    description: List of network zones
                    items:
                      $ref: '#/components/schemas/NetworkZone'
                    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 zones
      tags:
      - network-zones
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
    NetworkZoneRecord:
      properties:
        config:
          additionalProperties:
            type: string
          description: Advanced configuration for the record
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the record
          example: SPF record
          type: string
          x-go-name: Description
        entries:
          description: Entries in the record
          items:
            $ref: '#/components/schemas/NetworkZoneRecordEntry'
          type: array
          x-go-name: Entries
        name:
          description: The name of the record
          example: '@'
          type: string
          x-go-name: Name
      title: NetworkZoneRecord represents a network zone (DNS) record.
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    NetworkZone:
      properties:
        access_entitlements:
          description: AccessEntitlements represents the entitlements that are granted to the requesting user on the attached entity.
          example:
          - can_view
          - can_edit
          items:
            type: string
          type: array
          x-go-name: AccessEntitlements
        config:
          additionalProperties:
            type: string
          description: Zone configuration map (refer to doc/network-zones.md)
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the network zone
          example: Internal domain
          type: string
          x-go-name: Description
        name:
          description: The name of the zone (DNS domain name)
          example: example.net
          type: string
          x-go-name: Name
        project:
          description: 'Project name


            API extension: network_zones_all_projects'
          example: project1
          type: string
          x-go-name: Project
        used_by:
          description: List of URLs of objects using this network zone
          example:
          - /1.0/networks/foo
          - /1.0/networks/bar
          items:
            type: string
          readOnly: true
          type: array
          x-go-name: UsedBy
      title: NetworkZone represents a network zone (DNS).
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    NetworkZoneRecordsPost:
      description: NetworkZoneRecordsPost represents the fields of a new LXD network zone record
      properties:
        config:
          additionalProperties:
            type: string
          description: Advanced configuration for the record
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the record
          example: SPF record
          type: string
          x-go-name: Description
        entries:
          description: Entries in the record
          items:
            $ref: '#/components/schemas/NetworkZoneRecordEntry'
          type: array
          x-go-name: Entries
        name:
          description: The record name in the zone
          example: '@'
          type: string
          x-go-name: Name
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    NetworkZoneRecordEntry:
      description: NetworkZoneRecordEntry represents the fields in a record entry
      properties:
        ttl:
          description: TTL for the entry
          example: 3600
          format: uint64
          type: integer
          x-go-name: TTL
        type:
          description: Type of DNS entry
          example: TXT
          type: string
          x-go-name: Type
        value:
          description: Value for the record
          example: v=spf1 mx ~all
          type: string
          x-go-name: Value
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    NetworkZonesPost:
      description: NetworkZonesPost represents the fields of a new LXD network zone
      properties:
        config:
          additionalProperties:
            type: string
          description: Zone configuration map (refer to doc/network-zones.md)
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the network zone
          example: Internal domain
          type: string
          x-go-name: Description
        name:
          description: The name of the zone (DNS domain name)
          example: example.net
          type: string
          x-go-name: Name
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    NetworkZoneRecordPut:
      description: NetworkZoneRecordPut represents the modifiable fields of a LXD network zone record
      properties:
        config:
          additionalProperties:
            type: string
          description: Advanced configuration for the record
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the record
          example: SPF record
          type: string
          x-go-name: Description
        entries:
          description: Entries in the record
          items:
            $ref: '#/components/schemas/NetworkZoneRecordEntry'
          type: array
          x-go-name: Entries
      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
    NetworkZonePut:
      description: NetworkZonePut represents the modifiable fields of a LXD network zone
      properties:
        config:
          additionalProperties:
            type: string
          description: Zone configuration map (refer to doc/network-zones.md)
          example:
            user.mykey: foo
          type: object
          x-go-name: Config
        description:
          description: Description of the network zone
          example: Internal domain
          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
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            properties:
              error:
                example: not found
                type: string
                x-go-name: Error
              error_code:
                example: 404
                format: int64
                type: integer
                x-go-name: ErrorCode
              type:
                example: error
                type: string
                x-go-name: Type
            type: object

Canonical Network Zones API

Operations 14

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