Canonical

Canonical Restricted Queues API

The Restricted Queues API from Canonical — 2 operation(s) for restricted queues.

GitHub OpenAPI

Operations 4

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 /v1/restricted-queues List restricted queues and owners · List all agent's restricted queues and its owners #
Ask an LLM
“Which queues are restricted, and who owns them?”
“Can I see every restricted queue at once?”
Tell an agent
List all restricted queues and their owners.
Show who owns each restricted queue.
GET /v1/restricted-queues/{queue_name} Get a restricted queue's owners · Get restricted queues for a specific agent #
Ask an LLM
“Who is allowed to use a particular restricted queue?”
“Is a given queue restricted?”
Tell an agent
Show the owners of restricted queue {queue_name}.
Get restriction details for queue {queue_name}.
POST /v1/restricted-queues/{queue_name} Add an owner to a restricted queue · Add an owner to the specific restricted queue #
Ask an LLM
“How do I give a client access to a restricted queue?”
“Can a restricted queue have more than one owner?”
Tell an agent
Add client {client_id} as an owner of restricted queue {queue_name}.
Grant {client_id} ownership of queue {queue_name}.
DELETE /v1/restricted-queues/{queue_name} Remove an owner from a restricted queue · Delete an owner from the specific restricted queue #
Ask an LLM
“How do I take a client's access away from a restricted queue?”
“What happens when I remove an owner from a restricted queue?”
Tell an agent destructive · confirm first
Remove client {client_id} as owner of restricted queue {queue_name}.
Revoke {client_id}'s ownership of queue {queue_name}.

Documentation

📖
Documentation
https://snapcraft.io/docs/reference/development/snapd-rest-api/
📖
Documentation
https://ubuntu.com/landscape/docs
📖
APIReference
https://documentation.ubuntu.com/landscape/reference/api/
📖
Documentation
https://documentation.ubuntu.com/lxd/latest/rest-api/
📖
APIReference
https://documentation.ubuntu.com/lxd/latest/api-extensions/
📖
Documentation
https://ubuntu.com/security/api/docs
📖
APIReference
https://ubuntu.com/security/api/spec.json
📖
Documentation
https://documentation.ubuntu.com/pebble/
📖
Documentation
https://canonical-testflinger.readthedocs-hosted.com/en/latest/
📖
Documentation
https://documentation.ubuntu.com/anbox-cloud/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-restricted-queues-api-openapi.yml

Other Resources

🔗
HowTo
https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
🔗
ReleaseNotes
https://documentation.ubuntu.com/landscape/reference/release-notes/
🔗
Portal
https://ubuntu.com/landscape
🔗
SourceCode
https://github.com/canonical/lxd
🔗
Portal
https://canonical.com/lxd
🔗
Portal
https://ubuntu.com/security
🔗
SourceCode
https://github.com/canonical/pebble
🔗
SourceCode
https://github.com/canonical/testflinger
🔗
SourceCode
https://github.com/canonical/hardware-api
🔗
Portal
https://ubuntu.com/certified
🔗
SourceCode
https://github.com/canonical/identity-platform-api
🔗
SourceCode
https://github.com/canonical/test_observer
🔗
Portal
https://canonical.com/anbox-cloud
🔗
SourceCode
https://github.com/canonical/cos-registration-server

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-restricted-queues-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

canonical-restricted-queues-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Testflinger Restricted Queues API
  version: 1.0.0
servers:
- url: https://testflinger.ps7.canonical.com/
tags:
- name: Restricted Queues
paths:
  /v1/restricted-queues:
    get:
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictedQueueOut'
          description: Successful response
      tags:
      - Restricted Queues
      summary: List all agent's restricted queues and its owners
      operationId: getV1RestrictedQueues
      x-operation-id-source: derived
  /v1/restricted-queues/{queue_name}:
    get:
      parameters:
      - in: path
        name: queue_name
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestrictedQueueOut'
          description: Successful response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      tags:
      - Restricted Queues
      summary: Get restricted queues for a specific agent
      operationId: getV1RestrictedQueuesByQueueName
      x-operation-id-source: derived
    post:
      parameters:
      - in: path
        name: queue_name
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      tags:
      - Restricted Queues
      summary: Add an owner to the specific restricted queue
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestrictedQueueIn'
      operationId: postV1RestrictedQueuesByQueueName
      x-operation-id-source: derived
    delete:
      parameters:
      - in: path
        name: queue_name
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      tags:
      - Restricted Queues
      summary: Delete an owner from the specific restricted queue
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestrictedQueueIn'
      operationId: deleteV1RestrictedQueuesByQueueName
      x-operation-id-source: derived
components:
  schemas:
    HTTPError:
      properties:
        detail:
          type: object
        message:
          type: string
      type: object
    RestrictedQueueOut:
      type: object
      properties:
        queue:
          type: string
        owners:
          type: array
          items:
            type: string
      required:
      - owners
      - queue
      additionalProperties: false
    ValidationError:
      properties:
        detail:
          type: object
          properties:
            <location>:
              type: object
              properties:
                <field_name>:
                  type: array
                  items:
                    type: string
        message:
          type: string
      type: object
    RestrictedQueueIn:
      type: object
      properties:
        client_id:
          type: string
      required:
      - client_id
      additionalProperties: false