ServicesTemporal ServiceTemporal APIworkflow

Execute SpXOverlayDeletionWorkflow

View as Markdown

Delete a SpX Overlay and its associated VRFs/VXLANs with validation checks

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
Identifier of the SpX overlay to delete.
sitestringRequired
Site containing the SpX overlay to delete.
namespace_tagstringOptionalDefaults to spectrumx
Tag identifying the namespace used for allocation.

Response

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

Errors

422
Unprocessable Entity Error