Element Management Functions Device Configuration API

Version 7.1.0

v1.0 - 2025-05-21

Added

The following APIs are introduced with this release:

[Templates APIs]

  • POST /crosswork/config/v1/templates
    • New operation
  • PUT /crosswork/config/v1/templates
    • New operation
  • DELETE /crosswork/config/v1/templates
    • New operation
  • POST /crosswork/config/v1/templates/query
    • New operation
  • POST /crosswork/config/v1/templates/import
    • New operation
  • POST /crosswork/config/v1/templates/export
    • New operation
  • GET /crosswork/config/v1/templates/{templateName}
    • New operation
  • GET /crosswork/config/v1/templates/config/users
    • New operation
  • DELETE /crosswork/config/v1/templates/{name}/version/{version}
    • New operation

[Deployments APIs]

  • POST /crosswork/config/v1/jobs/deployments/query
    • New operation
  • POST /crosswork/config/v1/deploy-template
    • New operation
  • POST /crosswork/config/v1/deploy-template/{deploymentId}/query
    • New operation
  • POST /crosswork/config/v1/deploy-template/retry/{deploymentId}
    • New operation
  • DELETE /crosswork/config/v1/deploy-template/{deploymentId}
    • New operation
  • PATCH /crosswork/config/v1/deploy-template/{deploymentId}
    • New operation
  • GET /crosswork/config/v1/current-device-config
    • New operation

[Backup and Restore APIs]

  • PUT /crosswork/config/v1/resume-config-backup-restore-job/{name}
    • New operation
  • PUT /crosswork/config/v1/pause-config-backup-restore-job/{name}
    • New operation
  • POST /crosswork/config/v1/schedule-config-backup-job
    • New operation
  • PATCH /crosswork/config/v1/config-backup-job
    • New operation
  • DELETE /crosswork/config/v1/config-backup-restore-job
    • New operation
  • POST /crosswork/config/v1/config-backup-archive/{uuid}/{name}/{isSanitized}
    • New operation
  • PATCH /crosswork/config/v1/config-backup
    • New operation
  • DELETE /crosswork/config/v1/config-backup/{uuid}/{name}
    • New operation
  • DELETE /crosswork/config/v1/config-backup/{uuid}
    • New operation
  • DELETE /crosswork/config/v1/config-backup-restore-job/{name}
    • New operation

[Backup and Restore History APIs]

  • GET /crosswork/config/v1/latest-config-backup/{uuid}
    • New operation
  • GET /crosswork/config/v1/config-backup/{uuid}/{name}
    • New operation
  • GET /crosswork/config/v1/config-backup/{deviceUuid}
    • New operation

[Backup and Restore Jobs APIs]

  • POST /crosswork/config/v1/config-backup-jobs
    • New operation
  • POST /crosswork/config/v1/config-backup-job/{jobName}
    • New operation
  • GET /crosswork/config/v1/config-backup-job-run/{name}/{runId}
    • New operation

[Configuration Restore APIs]

  • PUT /crosswork/config/v1/resume-config-backup-restore-job/{name}
    • New operation
  • PUT /crosswork/config/v1/pause-config-backup-restore-job/{name}
    • New operation
  • POST /crosswork/config/v1/upload-config-file
    • New operation
  • POST /crosswork/config/v1/restore-config
    • New operation
  • PATCH /crosswork/config/v1/restore-config-job
    • New operation
  • DELETE /crosswork/config/v1/config-backup-restore-job
    • New operation
  • GET /crosswork/config/v1/restore-config-job/{jobName}
    • New operation
  • DELETE /crosswork/config/v1/config-backup-restore-job/{name}
    • New operation

[Configuration Backup History APIs]

  • GET /crosswork/config/v1/device-config-preferences/config-settings
    • New operation
  • PATCH /crosswork/config/v1/device-config-preferences/config-settings
    • New operation
  • PATCH crosswork/config/v1/device-config-preferences/reset-config-settings
    • New operation

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.