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

Ninox Modules API

The Modules API from Ninox — 2 operation(s) for modules.

Ninox Modules API is one of 5 APIs that Ninox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Modules. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://go.ninox.com.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://go.ninox.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ninox Modules API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearer).

  • bearer — Enter your Workspace API key. API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Paths & Operations 5

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

Modules 5
POST
/api/v1/workspace/{workspaceId}/modules
Create a module
ModulesV1Controller_createModule 1 param body → 201400401404500
GET
/api/v1/workspace/{workspaceId}/modules
List all modules in a workspace
ModulesV1Controller_getModules 1 param → 200401404500
DELETE
/api/v1/workspace/{workspaceId}/modules/{moduleName}
Delete a module
ModulesV1Controller_deleteModule 2 params → 200401404500
GET
/api/v1/workspace/{workspaceId}/modules/{moduleName}
Get a specific module
ModulesV1Controller_getModule 2 params → 200401404500
PATCH
/api/v1/workspace/{workspaceId}/modules/{moduleName}
Update a module
ModulesV1Controller_updateModule 2 params body → 200400401404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CreateModuleBody (6 properties), UpdateModuleBody (6 properties), ModulesResponse (1 property), ModuleResponse (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property 1 required
DeleteModuleResponse
object
1 property 1 required
UpdateModuleBody
object
Update Module request body
6 properties
CreateModuleBody
object
Create Module request body
6 properties 1 required
ModuleResponse
object
1 property 1 required
ModulesResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninox-modules-api-openapi.yml Raw ↑

Other APIs Ninox publishes across the network.

Ninox Fields API
Ninox Records API
Ninox Tables API
Ninox Workspace API