Skip to main content
New to Corsair? See API access, authentication, and error handling.

Admin

environmentReady

admin.environmentReady Check whether the environment is active and ready to render Risk: read
Input: empty object Output

environmentSummary

admin.environmentSummary Get environment status, plan details, and quota usage Risk: read
Input: empty object Output

getBatchUploadStatus

admin.getBatchUploadStatus Check status for a template batch upload job Risk: read
Input Output

getRenderQueue

admin.getRenderQueue Get current render queue utilization and delay Risk: read
Input: empty object Output

getRenderTags

admin.getRenderTags Get monthly render statistics grouped by custom tags Risk: read
Input Output

ping

admin.ping Check basic connectivity to the Docmosis API Risk: read
Input: empty object Output: empty object

pingService

admin.pingService Verify that Docmosis service listeners are online Risk: read
Input: empty object Output: empty object

Auth

getApiKey

auth.getApiKey Confirm a Docmosis access key is configured and return a masked preview of it Risk: read
Input: empty object Output

Images

delete

images.delete Delete one or more stored images Risk: destructive · Irreversible
Input Output

get

images.get Download one or more uploaded images Risk: read
Input Output

list

images.list List available stored images, optionally by folder Risk: read
Input Output

Templates

delete

templates.delete Delete one or more templates from the environment Risk: destructive · Irreversible
Input Output

get

templates.get Download one or more template files Risk: read
Input Output

getDetails

templates.getDetails Get metadata details for a specific template Risk: read
Input Output

getSampleData

templates.getSampleData Generate sample JSON or XML data from a template structure Risk: read
Input Output

getStructure

templates.getStructure Get parsed field and structure metadata for a template Risk: read
Input Output

list

templates.list List templates with optional folder and paging filters Risk: read
Input Output

render

templates.render Generate a document from a template and JSON/XML data Risk: write
Input Output