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

Nuxeo Configuration API

Configuration Information

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

Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 6 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.0.2, at version LTS 2021.

Requests are made against 2 base URLs: https://{host}:{port}/nuxeo/api/v1, https://nightly.nuxeo.com/nuxeo/api/v1.

6 operations 6 paths 4 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
LTS 2021
Base URL
https://{nuxeo-server}/nuxeo/api/v1
Authentication
HTTP Basic, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Nuxeo Configuration API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_auth). An API key is passed in the header as X-Authentication-Token (token).

Paths & Operations 6

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

Configuration 6

Configuration Information

GET
/config/types
List registered document type
ConfigurationTypesGet → 200401404
GET
/config/types/{docType}
Document type description
ConfigurationTypeDocumentGet 1 param → 200401404
GET
/config/facets
List registered facets
ConfigurationFacetsGet → 200401404
GET
/config/facets/{facet}
Facet description
ConfigurationFacetGet 1 param → 200401404
GET
/config/schemas
List registered schemas
ConfigurationSchemasGet → 200401404
GET
/config/schemas/{schema}
Schema description
ConfigurationSchemaGet 1 param → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are docType (5 properties), schema (3 properties), facet (2 properties), docTypes (2 properties). Each schema is shown below with its type and property counts.

schema
object
3 properties 3 required
docTypes
object
2 properties 2 required
docType
object
5 properties 5 required
facet
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-configuration-api-openapi.yml Raw ↑

Other APIs Nuxeo publishes across the network.

Nuxeo ACL API
Nuxeo Adapter API
Nuxeo Annotation API
Nuxeo Audit API
Nuxeo Automation API
Nuxeo Blob API
Nuxeo Business Object API
Nuxeo Children API
Nuxeo Conversion API
Nuxeo Directory API
Nuxeo Document API
Nuxeo Empty Document API