Neptune DXP Documentation
Neptune DXP - Open Edition · 25.0 MTS

APIs

API tools list, inspect, create, update, and delete the APIs of the API Designer. Saves run through the same validation pipeline and edit-lock checks as the Cockpit.

Required role: apidesigner.

If your user account does not have this role, every tool in this group fails immediately with an access denied error. Contact an administrator to request the role, or see Access control for more information on how roles are enforced.

Available tools

Parameters are shown with their type and a short description. UUIDs are always strings.

Tool Description Parameters

list_apis

List APIs. Returns a summary per API. The auth, endpoints, paths, and definitions of an API are never included in the list, even if you select them. Use get_api to read them.

listOptions (object, optional). Fields: name, description, version, apiGroup, ver, apiType, enableProxy, enableTrace, package, createdBy, changedBy, createdAt, updatedAt.

get_api

Return an API by its ID, including its endpoints, paths, and definitions.

id (string): ID of the API.

save_api

Create or update an API. Pass the full API object. Omit id to create a new API. The response contains the saved API with its name and package, and created, which is true if a new API was created.

api (object): The API object, including its paths and definitions. System fields, such as createdBy, changedBy, and ver, cannot be set.

delete_api

Delete an API by its ID.

id (string): ID of the API.

Related topics