Skip to main content
POST
Install Canvas Extension Endpoint

Authorizations

X-Session-API-Key
string
header
required

Body

application/json

Request body for installing a canvas extension.

source
string
required

Canvas extension source - git URL, GitHub shorthand, or local path. Examples: 'github:owner/repo', '/path/to/extension'

Minimum string length: 1
force
boolean
default:false

If true, overwrite existing installation

ref
string | null

Optional branch, tag, or commit to install

repo_path
string | null

Subdirectory path within the repository (for monorepos)

Response

Successful Response

Response containing installed canvas extension information.

install_path
string
required

Path where the extension is installed

installed_at
string
required

ISO 8601 timestamp of installation

name
string
required

Canvas extension name

source
string
required

Original source (e.g., 'github:owner/repo')

description
string
default:""

Canvas extension description

enabled
boolean
default:false

Whether the canvas extension is enabled

manifest
CanvasExtensionManifest · object | null

The extension's validated manifest (display_name, contributes.pages, ...). None if the installed manifest can no longer be read.

repo_path
string | null

Subdirectory path within the repository

resolved_ref
string | null

Resolved git commit SHA

version
string
default:""

Canvas extension version