API Changelog

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

Release 3.1.1 (2024-03-01)

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

The following What's New, What's Changed, and What's Deleted sections list the API changes between release 3.0.1 and 3.1.1.

What's New

---

GET /nexus/api/sitemanagement/v4/sitegroups

POST /nexus/api/sitemanagement/v4/sitegroups

GET /nexus/api/sitemanagement/v4/sitegroups/{specName}

PUT /nexus/api/sitemanagement/v4/sitegroups/{specName}

DELETE /nexus/api/sitemanagement/v4/sitegroups/{specName}

PATCH /nexus/api/sitemanagement/v4/sitegroups/{specName}

GET /nexus/infra/api/certmanagement/v4/trustedcas

POST /nexus/infra/api/certmanagement/v4/trustedcas

GET /nexus/infra/api/certmanagement/v4/trustedcas/{specName}

PUT /nexus/infra/api/certmanagement/v4/trustedcas/{specName}

DELETE /nexus/infra/api/certmanagement/v4/trustedcas/{specName}

GET /nexus/infra/api/credmgr/v4/credentials

POST /nexus/infra/api/credmgr/v4/credentials

GET /nexus/infra/api/credmgr/v4/credentials/{specName}

PUT /nexus/infra/api/credmgr/v4/credentials/{specName}

DELETE /nexus/infra/api/credmgr/v4/credentials/{specName}

PATCH /nexus/infra/api/credmgr/v4/credentials/{specName}

GET /nexus/infra/api/platform/v1/networkstorages

Get all network storages

POST /nexus/infra/api/platform/v1/networkstorages

Create a network storage

GET /nexus/infra/api/platform/v1/networkstorages/{specName}

Get a network storage

PUT /nexus/infra/api/platform/v1/networkstorages/{specName}

Modify a network storage

DELETE /nexus/infra/api/platform/v1/networkstorages/{specName}

Delete a network storage

What's Deleted

---

GET /nexus/infra/api/audit/v1/records

Get list of Audit Records

GET /nexus/infra/api/audit/v1/records/{metadataID}

Get an Audit Record

PUT /nexus/infra/api/firmware/v1/serviceinstancerestarts/serviceName/{serviceName}/instanceName/{instanceName}

Trigger a service instance restart

GET /nexus/infra/api/firmware/v1/serviceinstances

Get list of service instances

POST /nexus/infra/api/firmware/v1/serviceinstances

Create a service instance

GET /nexus/infra/api/firmware/v1/serviceinstances/serviceName/{serviceName}/instanceName/{instanceName}

Get a service instance

PUT /nexus/infra/api/firmware/v1/serviceinstances/serviceName/{serviceName}/instanceName/{instanceName}

Update a service instance

DELETE /nexus/infra/api/firmware/v1/serviceinstances/serviceName/{serviceName}/instanceName/{instanceName}

Delete a service instance

GET /nexus/infra/api/firmware/v1/servicepackageimports

Get list of service package imports

POST /nexus/infra/api/firmware/v1/servicepackageimports

Create a service package import

GET /nexus/infra/api/firmware/v1/servicepackageimports/{metadataID}

Get a service package import

DELETE /nexus/infra/api/firmware/v1/servicepackageimports/{metadataID}

Delete a service package import

GET /nexus/infra/api/firmware/v1/servicepackages

Get list of service packages

GET /nexus/infra/api/firmware/v1/servicepackages/{specName}

Get a service package

DELETE /nexus/infra/api/firmware/v1/servicepackages/{specName}

Delete a service package

GET /nexus/infra/api/firmware/v1/services

Get list of services

GET /nexus/infra/api/firmware/v1/services/{specServiceID}

Get a service

DELETE /nexus/infra/api/firmware/v1/services/{specServiceID}

Delete a service

GET /nexus/infra/api/installer/v1/actions

Get list of installer actions

POST /nexus/infra/api/installer/v1/actions

Create an installer action

GET /nexus/infra/api/installer/v1/actions/{metadataID}

Get installer action

What's Changed

---

GET /nexus/infra/api/aaa/v4/defaultauth/{specDefaultDomain}

Parameters:

Added: X-Csrf-Token in header

PUT /nexus/infra/api/aaa/v4/defaultauth/{specDefaultDomain}

Parameters:

Added: X-Csrf-Token in header

DELETE /nexus/infra/api/aaa/v4/securitydomains/{specName}

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/securitydomains/{specName}

Parameters:

Added: X-Csrf-Token in header

PUT /nexus/infra/api/aaa/v4/securitydomains/{specName}

Parameters:

Added: X-Csrf-Token in header

DELETE /nexus/infra/api/aaa/v4/trustedjwtkeys/{specKeyID}

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/trustedjwtkeys/{specKeyID}

Parameters:

Added: X-Csrf-Token in header

PUT /nexus/infra/api/aaa/v4/trustedjwtkeys/{specKeyID}

Parameters:

Added: X-Csrf-Token in header

DELETE /nexus/infra/api/aaa/v4/userapikeys/{specUuid}

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/userapikeys/{specUuid}

Parameters:

Added: X-Csrf-Token in header

PUT /nexus/infra/api/aaa/v4/userapikeys/{specUuid}

Parameters:

Added: X-Csrf-Token in header

POST /nexus/api/federation/v4/federations

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

POST /nexus/api/sitemanagement/v4/fabrics

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/infra/api/aaa/v4/defaultauth

Parameters:

Added: X-Csrf-Token in header

DELETE /nexus/infra/api/aaa/v4/logindomains/{specDomain}

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/logindomains/{specDomain}

Parameters:

Added: X-Csrf-Token in header

PUT /nexus/infra/api/aaa/v4/logindomains/{specDomain}

Parameters:

Added: X-Csrf-Token in header

POST /nexus/infra/api/aaa/v4/securitydomains

Parameters:

Added: X-Csrf-Token in header

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/infra/api/aaa/v4/securitydomains

Parameters:

Added: X-Csrf-Token in header

POST /nexus/infra/api/aaa/v4/trustedjwtkeys

Parameters:

Added: X-Csrf-Token in header

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/infra/api/aaa/v4/trustedjwtkeys

Parameters:

Added: X-Csrf-Token in header

POST /nexus/infra/api/aaa/v4/userapikeys

Parameters:

Added: X-Csrf-Token in header

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/infra/api/aaa/v4/userapikeys

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/userpreferences/{specLoginID}

Parameters:

Added: X-Csrf-Token in header

PUT /nexus/infra/api/aaa/v4/userpreferences/{specLoginID}

Parameters:

Added: X-Csrf-Token in header

POST /nexus/api/federation/v4/members

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/api/sitemanagement/v4/sites/{specName}

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property spec (object)

    • Deleted property internalOnboard (boolean)

      internally on-boarded by services

PUT /nexus/api/sitemanagement/v4/sites/{specName}

Request:

Changed content type : application/json

• Changed property spec (object)

  • Deleted property internalOnboard (boolean)

    internally on-boarded by services

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property spec (object)

    • Deleted property internalOnboard (boolean)

      internally on-boarded by services

GET /nexus/infra/api/aaa/v4/gatewayconfiguration/{specName}

Parameters:

Added: X-Csrf-Token in header

PUT /nexus/infra/api/aaa/v4/gatewayconfiguration/{specName}

Parameters:

Added: X-Csrf-Token in header

DELETE /nexus/infra/api/aaa/v4/localusers/{specLoginID}

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/localusers/{specLoginID}

Parameters:

Added: X-Csrf-Token in header

PUT /nexus/infra/api/aaa/v4/localusers/{specLoginID}

Parameters:

Added: X-Csrf-Token in header

POST /nexus/infra/api/aaa/v4/logindomains

Parameters:

Added: X-Csrf-Token in header

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/infra/api/aaa/v4/logindomains

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/remoteusers/{specLoginID}

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/userpreferences

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventconfigs/{specId}

Parameters:

Added: X-Nd-Rbac in header

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property spec (object)

    • Changed property alertConfig (object)

      Alert configuration being monitored as part of event configuration

      • Changed property severityConditions (array)

        Types of severity conditions to track

        Changed items (object): > Types of severity conditions to track

        • Added property key (string)

          label or key to compare value

GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventrecords/{specMetaName}

Parameters:

Added: X-Nd-Rbac in header

PUT /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventrecords/{specMetaName}

Parameters:

Added: X-Nd-Rbac in header

GET /nexus/infra/api/platform/v1/clusters/{specName}

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property spec (object)

    • Added property displayName (string)

      Cluster Display name

    • Added property networkMode (string)

      Shows what IP protocols are configured on this cluster

      Enum values:

      • SingleStack-IPV4
      • SingleStack-IPV6
      • DualStack

PUT /nexus/infra/api/platform/v1/clusters/{specName}

Request:

Changed content type : application/json

• Changed property spec (object)

  • Added property displayName (string)

    Cluster Display name

  • Added property networkMode (string)

    Shows what IP protocols are configured on this cluster

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property spec (object)

    • Added property displayName (string)

      Cluster Display name

    • Added property networkMode (string)

      Shows what IP protocols are configured on this cluster

POST /nexus/infra/api/platform/v1/externalips

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/infra/api/platform/v1/nodes/{specName}

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property status (object)

    • Added property hardwareStatus (object)

      Hardware specs of the node

      • Property cpu (object)

        Node Cpu stats

        • Property cores (integer)

          Total number of CPU cores

      • Property disks (array)

        Node disk list

        Items (object): > Node Disk Stats

        • Property capacity (integer)

          Total size (Bytes)

        • Property name (string)

          Disk name

        • Property storageController (string)

          Enum values:

          • Unknown
          • IDE
          • SCSI
          • NVMe
          • virtio
          • MMC

        • Property type (string)

          Disk type

          Enum values:

          • Unknown
          • HDD
          • SSD

      • Property memory (object)

        Node Memory stats

        • Property capacity (integer)

          Total Memory (GB)

    • Changed property state (string)

      Node operational Status

      Added enum value:

      • MigratingToDualStack

  • Changed property spec (object)

    • Added property cimcIP (string)

      Node cimc IP (physical only)

PUT /nexus/infra/api/platform/v1/nodes/{specName}

Request:

Changed content type : application/json

• Changed property spec (object)

  • Added property cimcIP (string)

    Node cimc IP (physical only)

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property status (object)

    • Added property hardwareStatus (object)

      Hardware specs of the node

    • Changed property state (string)

      Node operational Status

      Added enum value:

      • MigratingToDualStack

  • Changed property spec (object)

    • Added property cimcIP (string)

      Node cimc IP (physical only)

POST /nexus/infra/api/platform/v1/routes

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

POST /nexus/infra/api/platform/v1/syslogsyncs

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/infra/api/platform/v2/clusters/{specName}

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property spec (object)

    • Added property displayName (string)

      Cluster Display name

    • Added property networkMode (string)

      Shows what IP protocols are configured on this cluster

    • Changed property ntpConfig (object)

      Cluster NTP config

      • Changed property servers (array)

        Cluster NTP servers

        Changed items (object): > Cluster NTP Server

        • Changed property keyID (integer -> *int)

          Cluster NTP server symmetrical key ID

PUT /nexus/infra/api/platform/v2/clusters/{specName}

Request:

Changed content type : application/json

• Changed property spec (object)

  • Added property displayName (string)

    Cluster Display name

  • Added property networkMode (string)

    Shows what IP protocols are configured on this cluster

  • Changed property ntpConfig (object)

    Cluster NTP config

    • Changed property servers (array)

      Cluster NTP servers

      Changed items (object): > Cluster NTP Server

      • Changed property keyID (integer -> *int)

        Cluster NTP server symmetrical key ID

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property spec (object)

    • Added property displayName (string)

      Cluster Display name

    • Added property networkMode (string)

      Shows what IP protocols are configured on this cluster

    • Changed property ntpConfig (object)

      Cluster NTP config

      • Changed property servers (array)

        Cluster NTP servers

        Changed items (object): > Cluster NTP Server

        • Changed property keyID (integer -> *int)

          Cluster NTP server symmetrical key ID

POST /nexus/api/sitemanagement/v4/sites

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

• Changed property spec (object)

  • Deleted property internalOnboard (boolean)

    internally on-boarded by services

Return Type:

Changed response : 201 Created

Created

• Changed content type : application/json

  • Changed property spec (object)

    • Deleted property internalOnboard (boolean)

      internally on-boarded by services

GET /nexus/api/sitemanagement/v4/sites

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property items (array)

    Changed items (object): > Site Resource

    • Changed property spec (object)

      • Deleted property internalOnboard (boolean)

        internally on-boarded by services

GET /nexus/infra/api/aaa/v4/gatewayconfiguration

Parameters:

Added: X-Csrf-Token in header

POST /nexus/infra/api/aaa/v4/localusers

Parameters:

Added: X-Csrf-Token in header

Request:

Changed content type : application/json

• Changed property metadata (object)

  New optional properties:

  • ID
  • namespace

GET /nexus/infra/api/aaa/v4/localusers

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/aaa/v4/remoteusers

Parameters:

Added: X-Csrf-Token in header

GET /nexus/infra/api/eventmonitoring/v1/eventconfigs

Parameters:

Added: X-Nd-Rbac in header

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property items (array)

    Changed items (object): > Configuration to monitor a specific or group of resources on ND

    • Changed property spec (object)

      • Changed property alertConfig (object)

        Alert configuration being monitored as part of event configuration

        • Changed property severityConditions (array)

          Types of severity conditions to track

          Changed items (object): > Types of severity conditions to track

          • Added property key (string)

            label or key to compare value

GET /nexus/infra/api/eventmonitoring/v1/eventrecords

Parameters:

Added: X-Nd-Rbac in header

GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventconfigs

Parameters:

Added: X-Nd-Rbac in header

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property items (array)

    Changed items (object): > Configuration to monitor a specific or group of resources on ND

    • Changed property spec (object)

      • Changed property alertConfig (object)

        Alert configuration being monitored as part of event configuration

        • Changed property severityConditions (array)

          Types of severity conditions to track

          Changed items (object): > Types of severity conditions to track

          • Added property key (string)

            label or key to compare value

GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventrecords

Parameters:

Added: X-Nd-Rbac in header

GET /nexus/infra/api/platform/v1/clusters

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property items (array)

    Changed items (object): > Resource that represents configuration of the cluster

    • Changed property spec (object)

      • Added property displayName (string)

        Cluster Display name

      • Added property networkMode (string)

        Shows what IP protocols are configured on this cluster

GET /nexus/infra/api/platform/v1/nodes

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property items (array)

    Changed items (object): > Resource that represents a node in the cluster

    • Changed property status (object)

      • Added property hardwareStatus (object)

        Hardware specs of the node

      • Changed property state (string)

        Node operational Status

        Added enum value:

        • MigratingToDualStack

    • Changed property spec (object)

      • Added property cimcIP (string)

        Node cimc IP (physical only)

GET /nexus/infra/api/platform/v2/clusters

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property items (array)

    Changed items (object): > Resource that represents configuration of the cluster

    • Changed property spec (object)

      • Added property displayName (string)

        Cluster Display name

      • Added property networkMode (string)

        Shows what IP protocols are configured on this cluster

      • Changed property ntpConfig (object)

        Cluster NTP config

        • Changed property servers (array)

          Cluster NTP servers

          Changed items (object): > Cluster NTP Server

          • Changed property keyID (integer -> *int)

            Cluster NTP server symmetrical key ID