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 Related Items API

Related Items

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

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

This API exposes 11 operations across 11 paths, and defines 10 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.

11 operations 11 paths 10 schemas 2 DELETE5 GET4 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 Related Items 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 11

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

Related Items 11

Related Items

POST
/v2/related-items/entity/{entityType}/{entityId}/attachment
Create Attachment Relation
createRelatedItem 2 params body → 200
POST
/v2/related-items/entity/{entityType}/{entityId}/relation
Create entity relation
createRelatedItemForEntity 2 params body → 200
POST
/v2/related-items/entity/{entityType}/{entityId}/relations
Create entity relations
createRelatedItemForEntity_1 2 params body → 200
POST
/v2/related-items/entity/{entityType}/{entityId}/secure
Create Secure Relation
createSecureRelatedItemForEntity 2 params body → 200
DELETE
/v2/related-items/{relatedItemId}
Delete related item
deleteRelatedItem 1 param → 204
DELETE
/v2/related-items/{entityType}/{entityId}
Delete related items
deleteRelatedItems 2 params → 204
GET
/v2/related-items
List all related items
getAllRelatedItems → 200
GET
/v2/related-items/with-entity/{entityType}/{entityId}
List host entity related items by scope
getRelatedItemsForHostEntity 3 params → 200
GET
/v2/related-items/with-related-entity/{relEntityType}/{relEntityId}
List related entity related items
getRelatedItemsWithEntity 2 params → 200
GET
/v2/related-items/with-related-entity-type/{relatedEntityType}
List related entity type related items
getRelatedItemsWithEntityType 1 param → 200
GET
/v2/related-items/with-entity-type/{entityType}
List host entity type related items
getRelatedItemsWithHostEntityType 1 param → 200

Schemas 10

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

BodyPart
object
8 properties
FormDataContentDisposition
object
8 properties
MessageBodyWorkers
object
ContentDisposition
object
7 properties
MultiPart
object
9 properties
NewRelatedItemSecureValueRequest
object
6 properties
ParameterizedHeader
object
2 properties
FormDataBodyPart
object
12 properties
RelatedItemPublicApiDTO
object
13 properties
NewRelatedItemEntityRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-related-items-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 Knowledge Base Articles API
NinjaOne Location API
NinjaOne management API
NinjaOne organization API