ServicesTemporal ServiceTemporal APIworkflow

Execute SpXOverlayCreationWorkflow

View as Markdown

Create a SpX Overlay with route distinguisher assignment and VRF/VXLAN provisioning

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Request

This endpoint expects an object.
overlay_idstringRequired

Unique identifier for the SpX overlay. Used as an idempotency key — re-running with the same ID returns existing VRFs without creating new ones.

sitestringRequired
Site where the SpX overlay will be created.
tenantstringRequired
Tenant that will own the SpX overlay.
namespace_tagstringOptionalDefaults to spectrumx
Tag identifying the namespace used for allocation.
rd_maxintegerOptionalDefaults to 65000

Upper bound of the route-distinguisher allocation range (0–65535). Must be greater than rd_min.

rd_minintegerOptionalDefaults to 60000

Lower bound of the route-distinguisher allocation range (0–65535). The first available RD in [rd_min, rd_max] is allocated.

Response

Successful Response
hrefstringRead-only
Calculate URL to Temporal UI Workflow View.
idstring

Errors

422
Unprocessable Entity Error