For the complete documentation index, see llms.txt. This page is also available as Markdown.

Brand Configs

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:


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

Last updated

Was this helpful?