Get Installed Canvas Extension Endpoint
curl --request GET \
--url https://api.example.com/api/canvas-extensions/installed/{extension_name} \
--header 'X-Session-API-Key: <api-key>'import requests
url = "https://api.example.com/api/canvas-extensions/installed/{extension_name}"
headers = {"X-Session-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};
fetch('https://api.example.com/api/canvas-extensions/installed/{extension_name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/canvas-extensions/installed/{extension_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Session-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/canvas-extensions/installed/{extension_name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Session-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/canvas-extensions/installed/{extension_name}")
.header("X-Session-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/canvas-extensions/installed/{extension_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"install_path": "<string>",
"installed_at": "<string>",
"name": "<string>",
"source": "<string>",
"description": "",
"enabled": false,
"manifest": {
"display_name": "<string>",
"entrypoint": "<string>",
"name": "<string>",
"schema_version": 123,
"version": "<string>",
"backend": {
"argv": [
"<string>"
],
"artifacts": {},
"schema_version": 1,
"health": {
"interval_seconds": 0.1,
"path": "/health",
"timeout_seconds": 30
},
"inherit_environment": [
"<string>"
]
},
"contributes": {
"pages": [
{
"id": "<string>",
"path": "<string>",
"title": "<string>"
}
]
},
"description": "",
"icon": "<string>"
},
"repo_path": "<string>",
"resolved_ref": "<string>",
"version": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Canvas Extensions
Get Installed Canvas Extension Endpoint
Get information about a specific installed canvas extension.
GET
/
api
/
canvas-extensions
/
installed
/
{extension_name}
Get Installed Canvas Extension Endpoint
curl --request GET \
--url https://api.example.com/api/canvas-extensions/installed/{extension_name} \
--header 'X-Session-API-Key: <api-key>'import requests
url = "https://api.example.com/api/canvas-extensions/installed/{extension_name}"
headers = {"X-Session-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};
fetch('https://api.example.com/api/canvas-extensions/installed/{extension_name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/canvas-extensions/installed/{extension_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Session-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/canvas-extensions/installed/{extension_name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Session-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/canvas-extensions/installed/{extension_name}")
.header("X-Session-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/canvas-extensions/installed/{extension_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"install_path": "<string>",
"installed_at": "<string>",
"name": "<string>",
"source": "<string>",
"description": "",
"enabled": false,
"manifest": {
"display_name": "<string>",
"entrypoint": "<string>",
"name": "<string>",
"schema_version": 123,
"version": "<string>",
"backend": {
"argv": [
"<string>"
],
"artifacts": {},
"schema_version": 1,
"health": {
"interval_seconds": 0.1,
"path": "/health",
"timeout_seconds": 30
},
"inherit_environment": [
"<string>"
]
},
"contributes": {
"pages": [
{
"id": "<string>",
"path": "<string>",
"title": "<string>"
}
]
},
"description": "",
"icon": "<string>"
},
"repo_path": "<string>",
"resolved_ref": "<string>",
"version": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Path Parameters
Canvas extension name (lowercase alphanumeric, hyphens)
Required string length:
1 - 255Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Response
Successful Response
Response containing installed canvas extension information.
Path where the extension is installed
ISO 8601 timestamp of installation
Canvas extension name
Original source (e.g., 'github:owner/repo')
Canvas extension description
Whether the canvas extension is enabled
The extension's validated manifest (display_name, contributes.pages, ...). None if the installed manifest can no longer be read.
Show child attributes
Show child attributes
Subdirectory path within the repository
Resolved git commit SHA
Canvas extension version
Was this page helpful?

