Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NinjaOne Document Templates API

Document Templates

NinjaOne Document Templates API is one of 22 APIs that NinjaOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Document Templates. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 9 operations across 6 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version 2.0.9-draft.

Requests are made against the base URL https://app.ninjarmm.com/v2.

9 operations 6 paths 15 schemas 1 DELETE2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0.9-draft
Base URL
https://app.ninjarmm.com/v2
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NinjaOne Document Templates API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearer) (oauth2). An API key is passed in the cookie as sessionKey (sessionKey). By default, every request must be authenticated.

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Document Templates 9

Document Templates

POST
/v2/document-templates/{documentTemplateId}/archive
Archive a document template
archiveDocumentTemplate 1 param → 204
POST
/v2/document-templates/archive
Archive multiple document templates
archiveDocumentTemplates body → 204
GET
/v2/document-templates
List document templates with fields
getDocumentTemplatesWithAttributes 2 params → 200
POST
/v2/document-templates
Create document template
createDocumentTemplate body → 200
GET
/v2/document-templates/{documentTemplateId}
Get document template
getDocumentTemplate 2 params → 200
PUT
/v2/document-templates/{documentTemplateId}
Update document template
updateDocumentTemplate 1 param body → 200
DELETE
/v2/document-templates/{documentTemplateId}
Delete a document template
deleteDocumentTemplate 1 param → 204
POST
/v2/document-templates/{documentTemplateId}/restore
Restore a document template
restoreDocumentTemplate 1 param → 200
POST
/v2/document-templates/restore
Restore a document template
restoreDocumentTemplates body → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are DocumentItemPublicApiDTO (16 properties), UpdateDocumentItemPublicApiRequest (14 properties), DocumentTemplatePublicApiDTO (13 properties), NewDocumentItemPublicApiRequest (12 properties). Each schema is shown below with its type and property counts.

AttributeContentAdvancedSettingsNumericRange
object
2 properties
AttributeContentAdvancedSettingsComplexityRules
object
4 properties
UpdateDocumentTemplatePublicApiRequest
object
6 properties
UpdateDocumentItemPublicApiRequest
object
List of fields and ui elements
14 properties
NewDocumentItemPublicApiRequest
object
List of fields and ui elements
12 properties 2 required
AttributeContentAdvancedSettings
object
10 properties
DocumentItemPublicApiDTO
object
Document template fields
16 properties
NewDocumentAttributeContentPublicApi
object
Field content
5 properties
ArchiveUserInfo
object
Indicates who archived the template
3 properties
NewDocumentTemplatePublicApiRequest
object
7 properties 1 required
AttributeContentAdvancedSettingsDateFilters
object
2 properties
DocumentAttributeContentValuePublicApi
object
Used for dropdown options
3 properties
NewDocumentAttributeContentValuePublicApi
object
Used for dropdown options
1 property
DocumentTemplatePublicApiDTO
object
13 properties
DocumentAttributeContentPublicApi
object
Field content
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-document-templates-api-openapi.yml Raw ↑

Other APIs NinjaOne publishes across the network.

NinjaOne Asset Tags API
NinjaOne Backup API
NinjaOne Checklist Templates API
NinjaOne Custom Fields API
NinjaOne Custom Tabs API
NinjaOne devices API
NinjaOne groups API
NinjaOne Knowledge Base Articles API
NinjaOne Location API
NinjaOne management API
NinjaOne organization API
NinjaOne Organization Checklists API