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 Settings API

1NCE OS Settings

1NCE Settings 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 Settings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

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

2 operations 2 paths 9 schemas 1 GET1 PATCH

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 Settings 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 2

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

Settings 2

1NCE OS Settings

PATCH
/v1/settings/1nceos/{name}
Patch Settings
1 param body → 200400403500
GET
/v1/settings/1nceos
Get customer settings
3 params → 200400401403500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are getResponseschema_10_items_inner (4 properties), patchSettingResponseschema (3 properties), forbiddenResponse (3 properties), badRequestResponse (3 properties). Each schema is shown below with its type and property counts.

serverErrorResponse
object
An API error response in case of a Server Side Error.
2 properties
patchschema_2
object
Patch options for setting request.
2 properties 1 required
patchSettingResponseschema
object
Response to configuring a setting.
3 properties 3 required
unauthorizedRequestResponse
object
An API error response in case of an HTTP Unauthorized Request.
3 properties
getResponseschema_10
object
Get customer settings filtered by feature flags.
3 properties 3 required
getResponseschema_10_items_inner
object
4 properties 3 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
getResponseschema_10_items_inner_details
object
Details of the setting.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

1nce-settings-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 Plugin system API