Execute SpXOverlayTenantChangeWorkflow

POST

///v1/workflow/ngc/spx_overlay_tenant_change

Assign a SpX Overlay to a device 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.

overlay_idstringRequired

Identifier of the SpX overlay to assign and deploy tenant configuration for.

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.

Response

Successful Response

hrefstringRead-only

Calculate URL to Temporal UI Workflow View.

idstring

Errors

422

Unprocessable Entity Error

$	curl -X POST /v1/workflow/ngc/spx_overlay_tenant_change \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"device_id": "device-12345",
>	"overlay_id": "overlay-67890",
>	"port_names": [
>	"eth0",
>	"eth1"
>	],
>	"site": "datacenter-west-1"
>	}'