Skip to navigation
ServicesTemporal ServiceTemporal APIworkflow

Execute SpXOverlayTenantChangeWorkflow

View as MarkdownOpen in Claude
Change or remove a SpX Overlay assignment and deploy tenant configuration

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.
device_idstringRequired
Identifier of the target network device.
port_nameslist of stringsRequired
Names of the device interfaces to assign to the overlay.
sitestringRequired
Site containing the target network device.
namespace_tagstringOptionalDefaults to spectrumx
Tag identifying the namespace used for allocation.
overlay_idstring or nullOptional

Identifier of the SpX overlay to assign and deploy tenant configuration for. Omit the overlay_id property or explicitly set it to null to remove the selected ports’ current SpX assignment.

site_typestring or nullOptional
DCIM location type for the site identifier.

Response

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

Errors

422
Unprocessable Entity Error