Skip to main content
GET
Get Installed Canvas Extension Endpoint

Authorizations

X-Session-API-Key
string
header
required

Path Parameters

extension_name
string
required

Canvas extension name (lowercase alphanumeric, hyphens)

Required string length: 1 - 255
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

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