Canonical Client Permissions API

The Client Permissions API from Canonical — 2 operation(s) for client permissions.

Documentation 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/client-permissions List all client permissions · Retrieve all client permissions from database #

Ask an LLM

“Which clients have permissions on the Testflinger server?”

“What priority and reservation limits does every client have?”

Tell an agent

List every client's permissions.

Show all client IDs with their roles and limits.

GET /v1/client-permissions/{client_id} Get one client's permissions · Retrieve single client-permissions from database #

Ask an LLM

“What is the maximum priority a particular client may use?”

“Which role is assigned to a given client ID?”

Tell an agent

Show the permissions for client {client_id}.

Get the role and limits of client {client_id}.

PUT /v1/client-permissions/{client_id} Create or update client permissions · Add or create client permissions for a specified user #

Ask an LLM

“How do I grant a client a higher job priority?”

“Can I set a maximum reservation time for a client?”

Tell an agent

Set client {client_id} max priority to {max_priority}.

Create client {client_id} with role {role} and email {email}.

DELETE /v1/client-permissions/{client_id} Delete a client and its permissions · Delete client id along with its permissions #

Ask an LLM

“How do I remove a client ID entirely?”

“What happens to a client's permissions when it is deleted?”

Tell an agent destructive · confirm first

Delete client {client_id} and its permissions.

Remove client ID {client_id}.

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-client-permissions-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:
  title: Testflinger Client Permissions API
  version: 1.0.0
servers:
- url: https://testflinger.ps7.canonical.com/
tags:
- name: Client Permissions
paths:
  /v1/client-permissions:
    get:
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientPermissionsOut'
          description: Successful response
      tags:
      - Client Permissions
      summary: Retrieve all client permissions from database
      operationId: getV1ClientPermissions
      x-operation-id-source: derived
  /v1/client-permissions/{client_id}:
    get:
      parameters:
      - in: path
        name: client_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientPermissionsOut'
          description: Successful response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      tags:
      - Client Permissions
      summary: Retrieve single client-permissions from database
      operationId: getV1ClientPermissionsByClientId
      x-operation-id-source: derived
    put:
      parameters:
      - in: path
        name: client_id
        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:
      - Client Permissions
      summary: Add or create client permissions for a specified user
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientPermissionsIn'
      operationId: putV1ClientPermissionsByClientId
      x-operation-id-source: derived
    delete:
      parameters:
      - in: path
        name: client_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      tags:
      - Client Permissions
      summary: Delete client id along with its permissions
      operationId: deleteV1ClientPermissionsByClientId
      x-operation-id-source: derived
components:
  schemas:
    HTTPError:
      properties:
        detail:
          type: object
        message:
          type: string
      type: object
    ClientPermissionsIn:
      type: object
      properties:
        client_secret:
          type: string
          minLength: 15
        max_priority:
          type: object
          additionalProperties:
            type: integer
        max_reservation_time:
          type: object
          additionalProperties:
            type: integer
        role:
          type: string
          enum:
          - admin
          - manager
          - contributor
          - agent
        email:
          type: string
          format: email
      additionalProperties: false
    ClientPermissionsOut:
      type: object
      properties:
        client_id:
          type: string
        max_priority:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
        allowed_queues:
          type:
          - array
          - 'null'
          items:
            type: string
        max_reservation_time:
          type:
          - object
          - 'null'
          additionalProperties: {}
        role:
          type: string
        email:
          type:
          - string
          - 'null'
          format: email
      required:
      - allowed_queues
      - client_id
      - max_priority
      - max_reservation_time
      - role
      additionalProperties: false
    ValidationError:
      properties:
        detail:
          type: object
          properties:
            <location>:
              type: object
              properties:
                <field_name>:
                  type: array
                  items:
                    type: string
        message:
          type: string
      type: object

Canonical Client Permissions API

Operations 4

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification