Skip to main content

​
Overview

The Endpoints view in the Docs explorer is the browsable reference for every endpoint you’ve built in the APIs Playground. For each one it shows the request shape — method, URL, and parameters — plus a ready-to-run cURL and an OpenAPI spec. It’s the HTTP client documentation you hand to a developer so they can call your endpoints from their own tools (Postman, code, …). For the mental model, see Core concepts.
Endpoints (Docs explorer) vs. APIs Playground. You build and configure endpoints in the APIs Playground. This view is the read-only reference for calling them.

​
Where to find it

The Endpoints view lives under Docs explorer → Endpoints.

​
Browsing

The left panel lists every endpoint, searchable, grouped by module, then by type (for example Orchestration → Event), with each endpoint’s HTTP method (GET, POST, …) shown next to it. An OpenAPI selector lets you view or download the OpenAPI spec for all your endpoints — ready for Swagger or external clients.

​
Endpoint detail

Selecting an endpoint shows its reference:
FieldWhat it shows
ModuleThe CXF module the endpoint belongs to (e.g. Orchestration).
TypeThe endpoint’s library/type (e.g. Event).
StatusWhether it’s Enabled.
Method + URLThe HTTP method and full URL — …/api/v1/endpoints/{slug}.
ParametersThe exposed parameters — the ones a caller passes — each with its description.
Created / Last updatedTimestamps.

​
Try it

A Test configuration panel lets you call the endpoint without leaving CXF:
  • Fill the endpoint’s parameters.
  • Pick an API Key — only enabled keys are listed.
  • Run it, and copy the generated cURL, which sends the request with an Api-Key header (and a JSON body for write methods).

​
Governance & permissions

Only a super admin or Master can view and test endpoints here. The view is read-only — endpoints are edited in the APIs Playground.

​
API access

Endpoints are called at …/api/v1/endpoints/{slug} with an Api-Key header. See the API reference.

APIs Playground

Build and configure the endpoints listed here.

Bundles

Aggregate several endpoints into one call.

API Keys

The keys used to call an endpoint.