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 Custom Tabs API

The Custom Tabs API from NinjaOne — 13 operation(s) for custom tabs.

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

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

This API exposes 15 operations across 13 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.

15 operations 13 paths 15 schemas 1 DELETE7 GET6 PATCH1 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 Custom Tabs 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 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 7 GET, 6 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Tabs 15
POST
/v2/tab
Create a new Custom Tab
createCustomTabPublicApi body → 200
GET
/v2/tab/{tabId}
Retrieve a Custom Tab
getCustomTabPublicApi 1 param → 200404
DELETE
/v2/tab/{tabId}
Delete a Custom Tab
deleteUnmanagedDevicePublicApi_1 1 param → 200404
PATCH
/v2/tab/{tabId}
Update a Custom Tab
updateCustomTabPublicApi 1 param body → 200404
GET
/v2/tab/{tabId}/end-user
Retrieve the requested tab along with any extensions for end-user tabs
getTabHierarchyForEndUser 1 param → 200404
GET
/v2/tab/{tabId}/organization
Retrieve the requested tab along with any extensions for organization and location tabs
getTabHierarchyForOrganization 1 param → 200404
GET
/v2/tab/{tabId}/role/{roleId}
Retrieve the requested tab along with any extensions based on the supplied roleId
getTabHierarchyForRole 2 params → 200404
GET
/v2/tab/summary/end-user
Retrieve all of the custom tabs available to end user views
getTabSummaryForEndUser → 200
GET
/v2/tab/summary/organization
Retrieve all of the custom tabs available to organizations and locations
getTabSummaryForOrganization → 200
GET
/v2/tab/summary/role/{roleId}
Retrieve all of the custom tabs that would appear for the given role
getTabSummaryForRole 1 param → 200404
PATCH
/v2/tab/rename
Rename a Custom Tab
renameCustomTabPublicApi body → 200404
PATCH
/v2/tab/role/{roleId}/visibility
Set the tab visibility of the specified tab
updateCustomTabsDisplay 1 param body → 200
PATCH
/v2/tab/end-user/order
Update the order of custom tabs for end-user tabs
updateEndUserCustomTabsOrder body → 200
PATCH
/v2/tab/organization/order
Update the order of custom tabs for organizations and locations
updateOrganizationCustomTabsOrder body → 200
PATCH
/v2/tab/role/{roleId}/order
Update the order of custom tabs for a specific role
updateRoleCustomTabsOrder 1 param body → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are AttributeFormContentCommonItemPublicApiDTO (21 properties), AttributeContentAdvancedSettings (10 properties), CustomTabPublicApiDTO (9 properties), AttributeFormContentItemPublicApiDTO (8 properties). Each schema is shown below with its type and property counts.

CustomTabsOrderPublicApiDTO
object
2 properties
AttributeContentPublicApiDTO
object
For multi-select attributes, these are the available content options
7 properties
AttributeContentValue
object
4 properties
UpdateTabNamePublicApiRequest
object
2 properties 1 required
UpdateCustomTabPublicApiRequest
object
3 properties
AttributeFormContentCommonItemPublicApiDTO
object
This object represents either an attribute, or a UI Element. The available attributes will depend on which type it is
21 properties
AttributeContentAdvancedSettingsNumericRange
object
2 properties
CustomTabPublicApiDTO
object
9 properties
NewCustomTabPublicApiRequest
object
5 properties 1 required
AttributeContentAdvancedSettingsComplexityRules
object
4 properties
AttributeContentAdvancedSettings
object
10 properties
EndUserCustomization
object
3 properties
AttributeContentAdvancedSettingsDateFilters
object
2 properties
CustomTabsVisibilityPublicApiDTO
object
2 properties
AttributeFormContentItemPublicApiDTO
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-custom-tabs-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 devices API
NinjaOne Document Templates API
NinjaOne groups API
NinjaOne Knowledge Base Articles API
NinjaOne Location API
NinjaOne management API
NinjaOne organization API
NinjaOne Organization Checklists API