Nexus Dashboard API, Release 3.2(1)
Latest

API Changelog

The following sections describe API changes in each release of Nexus Dashboard.

Release 3.2.1 (2024-07-29)

For additional information about the release, see the Release Notes.

Breaking changes (4)

New (18)

Deprecated (0)

Updates (3)

Breaking changes

The following are changes to the API that may break an application or integration.

[Backup Restore]

  • POST /nexus/infra/api/platform/v1/exports
    • API Operation Summary: Create backup of the cluster config
    • ⛔️ Breaking Change - Removed operation
  • DELETE /nexus/infra/api/platform/v1/exports/{key}
    • API Operation Summary: Delete a backup file
    • ⛔️ Breaking Change - Removed operation
  • POST /nexus/infra/api/platform/v1/imports
    • API Operation Summary: Import cluster config from a backup file
    • ⛔️ Breaking Change - Removed operation
  • DELETE /nexus/infra/api/platform/v1/imports/{key}
    • API Operation Summary: Delete a an import file
    • ⛔️ Breaking Change - Removed operation

New

The following operations are introduced with this release:

[Backup Restore]

  • GET /api/action/class/backuprestore/backup
    • New operation: Get the list of all backups
  • POST /api/action/class/backuprestore/backup
    • New operation: Start a new backup
  • DELETE /api/action/class/backuprestore/backup/{name}
    • New operation: Delete a backup
  • GET /api/action/class/backuprestore/backup/{name}
    • New operation: Get details for a backup / Download a backup file
  • POST /api/action/class/backuprestore/restore
    • New operation: Perform a restore
  • DELETE /api/action/class/backuprestore/restore/file-import
    • New operation: Cancel file-import request
  • POST /api/action/class/backuprestore/restore/file-import
    • New operation: Import and validate a backup file to restore
  • GET /api/action/class/backuprestore/status
    • New operation: Get backup/restore status
  • GET /api/config/class/backuprestore/backup/schedule
    • New operation: Get list of backup schedules
  • POST /api/config/class/backuprestore/backup/schedule
    • New operation: Create a new backup schedule
  • DELETE /api/config/class/backuprestore/backup/schedule/{name}
    • New operation
  • GET /api/config/class/backuprestore/backup/schedule/{name}
    • New operation
  • PUT /api/config/class/backuprestore/backup/schedule/{name}
    • New operation
  • GET /api/config/class/securecopystorage
    • New operation: Get list of scp/sftp remote locations
  • POST /api/config/class/securecopystorage
    • New operation: Create a new scp/sftp remote location
  • DELETE /api/config/class/securecopystorage/{name}
    • New operation: Delete a remote scp/sftp location
  • GET /api/config/class/securecopystorage/{name}
    • New operation: Get a remote scp/sftp location
  • PUT /api/config/class/securecopystorage/{name}
    • New operation: Modify a scp/sftp remote location

Deprecated

The following operations and properties will be removed in future releases. Therefore, it is not recommended to use these resources.

Updates

[Event Monitoring]

  • GET /nexus/infra/api/eventmonitoring/v1/eventconfigs
    • API Operation Summary: Get a list of event configurations being monitored
    • added the optional property 'items/items/spec/alertConfig/allowEmptyResult' to the response with the '200' status
    • added the optional property 'items/items/spec/alertConfig/autoclear' to the response with the '200' status
    • added the optional property 'items/items/spec/dataSourceKey' to the response with the '200' status
  • GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventconfigs
    • API Operation Summary: Get a list of event configurations being monitored
    • added the optional property 'items/items/spec/alertConfig/allowEmptyResult' to the response with the '200' status
    • added the optional property 'items/items/spec/alertConfig/autoclear' to the response with the '200' status
    • added the optional property 'items/items/spec/dataSourceKey' to the response with the '200' status
  • GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventconfigs/{specId}
    • API Operation Summary: Get an event configuration
    • added the optional property 'spec/alertConfig/allowEmptyResult' to the response with the '200' status
    • added the optional property 'spec/alertConfig/autoclear' to the response with the '200' status
    • added the optional property 'spec/dataSourceKey' to the response with the '200' status
Next