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

1NCE Plugin system API

1NCE OS Plugin System

1NCE Plugin system API is one of 22 APIs that 1NCE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Plugin system. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 8 operations across 7 paths, and defines 23 schemas. It is described by OpenAPI 3.0.1, at version v2.1.1.

Requests are made against a single base URL, https://api.1nce.com/management-api.

8 operations 7 paths 23 schemas 1 DELETE2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v2.1.1
Server
https://api.1nce.com/management-api
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

1NCE Plugin system API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuthentication).

  • BasicAuthentication — Basic authentication used for obtaining the Bearer Authentication Token. The Bearer Token can then be used to make any further API calls towards the 1NCE API.

Paths & Operations 8

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

Plugin system 8

1NCE OS Plugin System

POST
/v1/partners/DATACAKE/plugins
Install Datacake plugin for 1NCE OS
body → 201400401403409500
POST
/v1/partners/MENDER/plugins
Install Mender plugin for 1NCE OS
body → 201400401403409500
POST
/v1/partners/TARTABIT/plugins
Install Tartabit plugin for 1NCE OS
body → 201400401403409500
POST
/v1/partners/MEMFAULT/plugins
Install Memfault plugin for 1NCE OS
body → 201400401403409500
DELETE
/v1/partners/plugins/{pluginId}
Uninstall a specific plugin by ID
1 param → 204401403404500
GET
/v1/partners/plugins/{pluginId}
Get details about a specific plugin installation
1 param → 200401403404500
POST
/v1/partners/plugins/{pluginId}/restart
Restart a failed plugin by installation ID
1 param → 200401403404409500
GET
/v1/partners/plugins
Get a list of plugin installations
→ 200401403500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are getResponseschema_15 (8 properties), postResponseschema_9 (8 properties), getResponseschema_13 (8 properties), postResponseschema_10 (7 properties). Each schema is shown below with its type and property counts.

postResponseschema_8
object
Response to the Datacake plugin installation request.
6 properties 6 required
restartResponseschema_plugin
getResponseschema_15
object
Plugin installation details by plugin ID. Also contains Memfault specific fields.
8 properties 8 required
restartResponseschema
object
Response to the plugin installation details by ID request.
3 properties 3 required
_v1_partners_plugins__pluginId__get_200_response
unauthorizedRequestResponse
object
An API error response in case of an HTTP Unauthorized Request.
3 properties
getAllResponseschema_6_items_inner
object
5 properties 5 required
notFoundResponse
object
An API error response when a resource is Not Found.
3 properties
postschema_9
object
A request to install the Mender plugin for 1NCE OS.
3 properties 1 required
postschema_11
object
A request to install the Memfault plugin for 1NCE OS.
conflictResponse
object
An API error response when a conflict is found.
3 properties
getAllResponseschema_6
object
List of Plugin installations
3 properties 3 required
postResponseschema_11
object
Response to the Memfault plugin installation request.
5 properties 5 required
getResponseschema_14
object
Plugin installation details by ID request. Also contains Tartabit specific fields.
7 properties 7 required
postschema_8
object
A request to install the Datacake plugin for 1NCE OS.
1 property 1 required
postschema_10
object
A request to install the Tartabit plugin for 1NCE OS.
2 properties 2 required
getResponseschema_12
object
Plugin installation details by ID request. Also contains Datacake specific fields.
6 properties 6 required
postResponseschema_10
object
Response to the Tartabit plugin installation request.
7 properties 7 required
serverErrorResponse
object
An API error response in case of a Server Side Error.
2 properties
postResponseschema_9
object
Response to the Mender plugin installation request.
8 properties 8 required
getResponseschema_13
object
Plugin installation details by ID request. Also contains Mender specific fields.
8 properties 8 required
badRequestResponse
object
An API error response in case of an HTTP Bad Request.
3 properties
forbiddenResponse
object
An API error response in case of an HTTP Forbidden Request.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

1nce-plugin-system-api-openapi.yml Raw ↑

Other APIs 1NCE publishes across the network.

1NCE Administration Logs API
1NCE Agreements API
1NCE Bearer Authorization API
1NCE Connectivity API
1NCE Device Inspector API
1NCE Device Locator API
1NCE Devices API
1NCE General SIMs API
1NCE IoT Integrator API
1NCE Optimizer API
1NCE Orders API
1NCE Products API