ServicesTemporal ServiceTemporal APIworkflow

Execute SiteBackupWorkflow

View as Markdown

Back up running configurations for in-scope devices at a site to the Config Store

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.
sitestringRequired>=1 character
Site containing the network devices to back up.
backup_enabled_onlybooleanOptionalDefaults to true
When true, only devices with backup enabled are included.
roleslist of stringsOptionalDefaults to []
Device roles used to filter the selected network devices.
statuslist of stringsOptionalDefaults to ["Active","Provisioned"]
Device statuses used to filter the selected network devices.
tenantstring or nullOptional
Tenant used to filter the selected network devices.
userstring or nullOptional
User that requested the site backup.
user_domainstring or nullOptional
Domain of the user requesting the site backup.

Response

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

Errors

422
Unprocessable Entity Error