Brand Configs

Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).

Brand Configs API

Get the brand config variables that should be used for this domain

BrandConfigsApiController#show

GET /api/v1/brand_variables

Scope: url:GET|/api/v1/brand_variables

Will redirect to a static json file that has all of the brand variables used by this account. Even though this is a redirect, do not store the redirected url since if the account makes any changes it will redirect to a new url. Needs no authentication.

Example Request:

curl 'https://<canvas>/api/v1/brand_variables'

Get the brand config variables for a sub-account or course

BrandConfigsApiController#show_context

GET /api/v1/accounts/:account_id/brand_variables

Scope: url:GET|/api/v1/accounts/:account_id/brand_variables

GET /api/v1/courses/:course_id/brand_variables

Scope: url:GET|/api/v1/courses/:course_id/brand_variables

Will redirect to a static json file that has all of the brand variables used by the provided context. Even though this is a redirect, do not store the redirected url since if the sub-account makes any changes it will redirect to a new url.

Example Request:

curl 'https://<canvas>/api/v1/accounts/123/brand_variables'
  -H 'Authorization: Bearer <token>'

---

This documentation is generated directly from the Canvas LMS source code, available on Github.