Console Resource Service: Overview
The Console Resource service provides operations that allow you to upload and manage platform resources such as platform CSS, customizable platform content pages, and platform help files. This service is used for any platform assets, stored in the /resources/ folder structure.
URL: /resources
Note: For information about IDs used in path parameters, see IDs on the Platform.
| Action | Endpoint | Description |
|---|---|---|
| add | POST /resources/{path:.*} | Adds a folder to the console /resources/ folder structure. |
| delete | DELETE /resources/{path:.*} | Deletes a console resource. |
| generate styles | POST /resources/branding/generatestyles | Generates platform styles for a specified theme or for all themes. |
| get | GET /resources/{path:.*} | Returns the platform resource, such as a CSS file, specified in the path. Can also return a folder and its contents in a ZIP file. |
| get settings | GET /resources/{ResourceVersionKey}/settings (with application/json Accept header) | Used prior to login: Returns a subset of the configurable settings for the tenant, such as login domains, password policy, and API and app settings. Additional settings, such as settings for alerts, connections, reviews, discussions, and comments, are returned after login. |
| get post-login settings | GET /resources/v2/{ResourceVersionKey}/settings (with application/vnd.akana.v2020+json Accept header) | Used after login: Returns information about all the configurable settings for the tenant, such as app, API, ticket, and business settings. |
| get resource version key | GET /resources/resourceversionkey | Returns the ResourceVersion Key for console resources. |
| rename | PUT /resources/{path:.*} | Renames a resource in the platform's /resources/ folder structure. |
| upload | POST /resources/{path:.*} | Uploads a Community Manager developer portal resource, such as a stylesheet, to the /resources/ folder structure. |