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 Knowledge Base Articles API

Knowledge Base Articles

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

Tagged areas include Knowledge Base Articles. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 19 operations across 18 paths, and defines 17 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.

19 operations 18 paths 17 schemas 8 GET2 PATCH9 POST

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 Knowledge Base Articles 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 19

Across 18 paths, the API surfaces 19 operations — 8 GET, 2 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Knowledge Base Articles 19

Knowledge Base Articles

POST
/v2/attachments/temp/upload
Upload temporary attachments
uploadTempAttachments 1 param body → 200
POST
/v2/knowledgebase/articles/archive
Archive knowledge base articles
archiveKnowledgeBaseArticles body → 204
POST
/v2/knowledgebase/folders/archive
Archive knowledge base folders
archiveKnowledgeBaseFolders body → 204
POST
/v2/knowledgebase/articles
Create knowledge base articles
createKnowledgeBaseArticles body → 200
PATCH
/v2/knowledgebase/articles
Update knowledge base articles
updateKnowledgeBaseArticles body → 200
POST
/v2/knowledgebase/articles/delete
Delete knowledge base articles
deleteKnowledgeBaseArticles body → 204
POST
/v2/knowledgebase/folders/delete
Delete knowledge base folders
deleteKnowledgeBaseFolders body → 204
GET
/v2/knowledgebase/article/{articleId}/download
Download knowledge base article
downloadKnowledgeBaseArticle 1 param → 204
GET
/v2/knowledgebase/organization/articles
Lists organization knowledge base articles
getClientKnowledgeBaseArticles 3 params → 200
GET
/v2/knowledgebase/global/articles
Lists global knowledge base articles
getGlobalKnowledgeBaseArticles 2 params → 200
GET
/v2/knowledgebase/article/{articleId}/signed-urls
Get knowledge base article signed urls
getKnowledgeBaseArticleSignedUrls 1 param → 200
GET
/v2/knowledgebase/folder/{folderId}
Returns knowledge base folder
getKnowledgeBaseFolderContent 2 params → 200
GET
/v2/knowledgebase/folder
Returns knowledge base folder
getKnowledgeBaseFolderPathContent 3 params → 200
PATCH
/v2/knowledgebase/folders/move
Move knowledge base items
move body → 204
POST
/v2/knowledgebase/articles/restore
Restore archive knowledge base articles
restoreKnowledgeBaseArticles body → 204
POST
/v2/knowledgebase/folders/restore
Restore archived knowledge base folders
restoreKnowledgeBaseFolders body → 204
POST
/v2/knowledgebase/articles/upload
Upload knowledge base articles
uploadKnowledgeBaseArticles body → 200
GET
/v2/related-items/{relatedItemId}/attachment/download
Download related item attachment
downloadRelatedItemAttachment 1 param → 204
GET
/v2/related-items/with-entity/{entityType}/{entityId}/attachments/signed-urls
Get related item attachments signed urls
getRelatedItemAttachmentsSignedUrls 2 params → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are KnowledgeBaseFolderItemPublicApiDTO (13 properties), KnowledgeBaseArticlePublicApiDTO (12 properties), FormDataBodyPart (12 properties), MultiPart (9 properties). Each schema is shown below with its type and property counts.

KnowledgeBaseFolderItemPublicApiDTO
object
Folder content
13 properties
KnowledgeBaseFolderPublicApiDTO
object
9 properties
BodyPart
object
8 properties
FormDataContentDisposition
object
8 properties
KnowledgeBaseArticlePublicApiDTO
object
12 properties
MessageBodyWorkers
object
ContentDisposition
object
7 properties
KnowledgeBaseArticlePublicApiContent
object
Article content
2 properties
KnowledgeBaseArticleBulkCreatePublicApiRequest
object
5 properties
MultiPart
object
9 properties
AttachmentMetadata
object
Attachment metadata
6 properties
ParameterizedHeader
object
2 properties
MovePublicApiRequest
object
4 properties
AttachmentMetadataPublicApiDTO
object
5 properties
KnowledgeBaseAttachmentPublicApiDTO
object
Lists the files associated with the article
3 properties
FormDataBodyPart
object
12 properties
KnowledgeBaseArticleBulkUpdatePublicApiRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-knowledge-base-articles-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 Document Templates API
NinjaOne groups API
NinjaOne Location API
NinjaOne management API
NinjaOne organization API
NinjaOne Organization Checklists API