Version: v1

Nexus API

The public Nexus API provides programmatic access to dab Nexus (v1.20+). Use it to automate workflows, integrate with external systems, or build custom reporting solutions — all without the Nexus UI.

Just getting started? Create an API key in your Nexus Settings.

Base URL

{scheme}://{host}/api/v1/

Replace {scheme} with https (recommended) or http, and {host} with your Nexus server hostname (e.g., nexus.example.com or nexus.local:8080).

Capabilities

• Workspaces — create, read, update, delete
• Tasks — create, schedule, enable/disable, update start time, delete
• Runs — trigger, monitor status, cancel
• Parameters — resolve by analytic group or extraction package
• Object IDs — resolve SAP connections, SQL connections, parameter tables

Authentication

Every request must include a valid API key in the Authorization header:

Authorization: ApiKey {your-key}

API keys are managed in Settings → API Keys within the Nexus application. Each key carries the permissions of the user that created it; endpoints require the corresponding permission. See API Keys for details on creating and managing keys.

Conventions

• Resources are addressed by their GUID id
• Timestamps use ISO 8601 format
• Errors are returned as application/problem+json responses carrying a type, status, and message, plus any problem-specific fields

HTTP Status Codes

Code	Status	Description
200	OK	Request succeeded
400	Bad Request	Invalid request — often due to missing or malformed parameters
401	Unauthorized	API key is missing or invalid
402	Request Failed	Parameters were valid but the request failed
403	Forbidden	API key lacks permission for this operation
404	Not Found	Requested resource does not exist
409	Conflict	Request conflicts with current resource state
424	External Dependency Failed	A dependency external to Nexus failed
429	Too Many Requests	Rate limit exceeded — slow down and retry
500, 502, 503, 504	Server Error	Something went wrong on the Nexus server

Authentication

API Key: ApiKey

Enter the full Authorization header value: ApiKey {your key}

Security Scheme Type:	apiKey
Header parameter name:	Authorization