Skip to content

Virtual URL API

Publish your own REST endpoints without code, and generate an OpenAPI document for them.

Version

Service: Workflow engine
Base path: https://your-workflow-host
Authentication: Bearer token and context headers.

A Virtual URL maps a method and path template, such as GET /vendors/{id}, to ordered steps (select, insert, update, delete) on your entities, with an output shape. Calls run under the caller's own permissions. Ask us to enable Virtual URLs on your environment.

POST/api/v1/virtualurls/upsert

Create or update a Virtual URL

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/virtualurls

List Virtual URLs

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

DELETE/api/v1/virtualurls/{id}

Delete a Virtual URL

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/virtualurls/openapi

Get the app's OpenAPI 3.1 document

Use it to generate a typed client for your endpoints.

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

ANY/vu/{path}

Call a Virtual URL

GET, POST, PUT and DELETE are supported. Send an X-Release-Id header to pin the call to a release. Update and delete steps refuse to run without criteria.

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.