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

The Audit API from Nuxeo — 2 operation(s) for audit.

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

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

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

2 operations 2 paths 2 schemas 2 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 Audit 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 2

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

Audit 2
GET
/id/{docId}/@audit
View the audit trail of a document given its id
DocumentIdAuditAdapterGet 1 param → 200401404
GET
/path/{docPath}/@audit
View the audit trail of a document given its path
DocumentPathAuditAdapterGet 1 param → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are LogEntries (19 properties), LogEntry (12 properties). Each schema is shown below with its type and property counts.

LogEntry
object
12 properties 12 required
LogEntries
object
19 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-audit-api-openapi.yml Raw ↑

Other APIs Nuxeo publishes across the network.

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