Canonical

Canonical Environment Reviews API

The environment-reviews API from Canonical — 2 operation(s) for environment-reviews.

GitHub OpenAPI

Operations 3

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/artefacts/{artefact_id}/environment-reviews List environment reviews for an artefact · Get Environment Reviews #
Ask an LLM
“What review decisions have been made for each environment an artefact was tested on?”
“Can I see which environments still need review for an artefact?”
Tell an agent
List environment reviews for artefact {artefact_id}.
Show review status per environment of artefact {artefact_id}.
PATCH /v1/artefacts/{artefact_id}/environment-reviews Update many environment reviews at once · Bulk Update Environment Reviews #
Ask an LLM
“Can I approve several environment reviews of an artefact in one request?”
“Is there a bulk way to record review decisions across environments?”
Tell an agent
Bulk update the environment reviews of artefact {artefact_id}.
Apply review decisions to all listed environments of artefact {artefact_id}.
PATCH /v1/artefacts/{artefact_id}/environment-reviews/{review_id} Record a decision on one environment review · Update Environment Review #
Ask an LLM
“How do I approve or reject a single environment's test results for an artefact?”
“Can I leave a comment on one environment review?”
Tell an agent
Set review {review_id} of artefact {artefact_id} to decision {decision}.
Comment {comment} on environment review {review_id} for artefact {artefact_id}.

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-environment-reviews-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-artefact-build-environment-review-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-environment-review-patch-schema.json

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-environment-reviews-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-environment-reviews-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Test Observer Environment Reviews API
  description: Test Observer API (see https://github.com/canonical/test_observer)
  license:
    name: GNU Affero General Public License v3
    url: https://raw.githubusercontent.com/canonical/test_observer/refs/heads/main/backend/LICENSE
  version: 0.1.0
tags:
- name: environment-reviews
paths:
  /v1/artefacts/{artefact_id}/environment-reviews:
    get:
      tags:
      - environment-reviews
      summary: Get Environment Reviews
      operationId: get_environment_reviews_v1_artefacts__artefact_id__environment_reviews_get
      parameters:
      - name: artefact_id
        in: path
        required: true
        schema:
          type: integer
          title: Artefact Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ArtefactBuildEnvironmentReviewResponse'
                title: Response Get Environment Reviews V1 Artefacts  Artefact Id  Environment Reviews Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - view_environment_review
    patch:
      tags:
      - environment-reviews
      summary: Bulk Update Environment Reviews
      operationId: bulk_update_environment_reviews_v1_artefacts__artefact_id__environment_reviews_patch
      parameters:
      - name: artefact_id
        in: path
        required: true
        schema:
          type: integer
          title: Artefact Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/EnvironmentReviewPatch'
              title: Requests
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ArtefactBuildEnvironmentReviewResponse'
                title: Response Bulk Update Environment Reviews V1 Artefacts  Artefact Id  Environment Reviews Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - change_environment_review
  /v1/artefacts/{artefact_id}/environment-reviews/{review_id}:
    patch:
      tags:
      - environment-reviews
      summary: Update Environment Review
      operationId: update_environment_review_v1_artefacts__artefact_id__environment_reviews__review_id__patch
      parameters:
      - name: artefact_id
        in: path
        required: true
        schema:
          type: integer
          title: Artefact Id
      - name: review_id
        in: path
        required: true
        schema:
          type: integer
          title: Review Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentReviewPatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtefactBuildEnvironmentReviewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-permissions:
      - change_environment_review
components:
  schemas:
    ArtefactBuildMinimalResponse:
      properties:
        id:
          type: integer
          title: Id
        architecture:
          type: string
          title: Architecture
        revision:
          anyOf:
          - type: integer
          - type: 'null'
          title: Revision
      type: object
      required:
      - id
      - architecture
      - revision
      title: ArtefactBuildMinimalResponse
    EnvironmentResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        architecture:
          type: string
          title: Architecture
      type: object
      required:
      - id
      - name
      - architecture
      title: EnvironmentResponse
    ReviewerResponse:
      properties:
        id:
          type: integer
          title: Id
        launchpad_handle:
          anyOf:
          - type: string
          - type: 'null'
          title: Launchpad Handle
        email:
          type: string
          title: Email
        launchpad_email:
          type: string
          title: Launchpad Email
          deprecated: true
        name:
          type: string
          title: Name
      type: object
      required:
      - id
      - email
      - launchpad_email
      - name
      title: ReviewerResponse
    EnvironmentReviewPatch:
      properties:
        id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Id
        review_decision:
          anyOf:
          - items:
              $ref: '#/components/schemas/ArtefactBuildEnvironmentReviewDecision'
            type: array
          - type: 'null'
          title: Review Decision
        review_comment:
          anyOf:
          - type: string
          - type: 'null'
          title: Review Comment
      type: object
      title: EnvironmentReviewPatch
    ArtefactBuildEnvironmentReviewDecision:
      type: string
      enum:
      - REJECTED
      - APPROVED_INCONSISTENT_TEST
      - APPROVED_UNSTABLE_PHYSICAL_INFRA
      - APPROVED_CUSTOMER_PREREQUISITE_FAIL
      - APPROVED_FAULTY_HARDWARE
      - APPROVED_ALL_TESTS_PASS
      title: ArtefactBuildEnvironmentReviewDecision
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ArtefactBuildEnvironmentReviewResponse:
      properties:
        id:
          type: integer
          title: Id
        review_decision:
          items:
            $ref: '#/components/schemas/ArtefactBuildEnvironmentReviewDecision'
          type: array
          title: Review Decision
        review_comment:
          type: string
          title: Review Comment
        environment:
          $ref: '#/components/schemas/EnvironmentResponse'
        artefact_build:
          $ref: '#/components/schemas/ArtefactBuildMinimalResponse'
        reviewers:
          items:
            $ref: '#/components/schemas/ReviewerResponse'
          type: array
          title: Reviewers
          default: []
      type: object
      required:
      - id
      - review_decision
      - review_comment
      - environment
      - artefact_build
      title: ArtefactBuildEnvironmentReviewResponse