How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canonical Session API

The session API from Canonical — 8 operation(s) for session.

Canonical Session API is one of 122 APIs that Canonical publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

This API exposes 11 operations across 8 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, /1.0/.

11 operations 8 paths 23 schemas 2 DELETE6 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.snapcraft.io
Contact
License
Proprietary
Resource Areas
1

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 2 DELETE, 6 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Session 11
GET
/1.0/session/{id}/sockets/adb
Join session as ADB client
handle-adb-connect-session
GET
/1.0/session/{id}/sockets/master
Join session as master
handle-master-connect-session
GET
/1.0/session/{id}/sockets/slave
Join session as slave
handle-slave-connect-session
GET
/1.0/sessions
Get all sessions
handle-get-sessions 6 params → 200500
POST
/1.0/sessions
Create session
handle-new-session body → 201400404500
DELETE
/1.0/sessions
Batch delete sessions
handle-delete-sessions 2 params body → 200202207400404500
GET
/1.0/sessions/{id}
Get session
handle-get-session 1 param → 200400404
DELETE
/1.0/sessions/{id}
Delete a session
handle-delete-session 3 params → 200400404500
GET
/1.0/sessions/{id}/connect
Connect a session
handle-connect-session → 200400401500
POST
/1.0/sessions/{id}/join
Join session
handle-join-session body → 200400404500
POST
/1.0/sessions/{id}/share
Share session
handle-share-session body → 200400404500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are api.Session (8 properties), api.SessionPost (8 properties), api.SessionPostResponseData (6 properties), api.SessionsGetResponse (6 properties). Each schema is shown below with its type and property counts.

api_gateway.Response
object
4 properties
api.SessionJoinPost
object
1 property
api.Session
object
8 properties
api.SessionsDelete
object
1 property
api.SessionJoinResponseData
object
2 properties
api.SessionPostResponse
object
5 properties
api.SessionsDeleteError
object
3 properties
api.SessionsDeleteResponse
object
5 properties
api.SessionStatus
string
api.SessionsGetResponse
object
6 properties
api_gateway.ResponseType
string
api.SessionSharePostResponse
object
5 properties
api.SessionSharePost
object
2 properties
api.SessionPost
object
8 properties
api_gateway.ResponseStatus
string
api.SessionPostResponseData
object
6 properties
api_gateway.StunServer
object
3 properties
api.SessionConnectGetResponse
object
5 properties
api.SessionJoinResponse
object
5 properties
api.Screen
object
4 properties
api.SessionGetResponse
object
5 properties
api.SessionConnectGetResponseData
object
2 properties
api.SessionSharePostResponseData
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-session-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
Charmhub API
MAAS API
Juju Client / Controller API
Launchpad Web Services API
Ubuntu Pro Client API
Canonical Assertions API
Canonical Search API
Canonical Snaps API
MicroCeph REST API
Canonical App Authorization Service API
Canonical Application API
Where this information came from

This is an independent, third-party profile of Canonical Session API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.