Nexus Dashboard API, Release 2.2(x)
API Changelog
The following sections describe API changes in each release of Nexus Dashboard.
Release 2.2.2 (2022-08-23)
For additional information about the release, see the Release Notes.
What's New
GET /nexus/api/federation/v4/federations - Get a list of Federation
POST /nexus/api/federation/v4/federations - Create a Federation
GET /nexus/api/federation/v4/federations/{statusFederationID} - Get a federation
DELETE /nexus/api/federation/v4/federations/{statusFederationID} - Delete a federation
GET /nexus/api/federation/v4/members - Get a list of Federation Member
POST /nexus/api/federation/v4/members - Create a federation member
GET /nexus/api/federation/v4/members/{statusMemberID} - Get a federation member
DELETE /nexus/api/federation/v4/members/{statusMemberID} - Delete a federation member
POST /nexus/api/sitemanagement/v4/fabrics - Get all Fabrics/sites
GET /nexus/api/sitemanagement/v4/sites - Get a list of site
POST /nexus/api/sitemanagement/v4/sites - Create a site
GET /nexus/api/sitemanagement/v4/sites/{specName} - Get a site
PUT /nexus/api/sitemanagement/v4/sites/{specName} - Modify a site
DELETE /nexus/api/sitemanagement/v4/sites/{specName} - Delete a site
GET /nexus/infra/api/aaa/v4/defaultauth - Get a list of default authentication login domain
GET /nexus/infra/api/aaa/v4/defaultauth/{specDefaultDomain} - Get default authentication login domain
PUT /nexus/infra/api/aaa/v4/defaultauth/{specDefaultDomain} - Modify a default authentication login domain
GET /nexus/infra/api/aaa/v4/gatewayconfiguration - Get a list of API gateway configuration
GET /nexus/infra/api/aaa/v4/gatewayconfiguration/{specName} - Get API gateway configuration
PUT /nexus/infra/api/aaa/v4/gatewayconfiguration/{specName} - Modify a gateway configuration
GET /nexus/infra/api/aaa/v4/localusers - Get a list of local user
POST /nexus/infra/api/aaa/v4/localusers - Create a local user
GET /nexus/infra/api/aaa/v4/localusers/{specLoginID} - Get a local user
PUT /nexus/infra/api/aaa/v4/localusers/{specLoginID} - Modify a local user
DELETE /nexus/infra/api/aaa/v4/localusers/{specLoginID} - Delete a local user
GET /nexus/infra/api/aaa/v4/logindomains - Get a list of login domain
POST /nexus/infra/api/aaa/v4/logindomains - Create a login domain
GET /nexus/infra/api/aaa/v4/logindomains/{specDomain} - Get a login domain
PUT /nexus/infra/api/aaa/v4/logindomains/{specDomain} - Modify a login domain
DELETE /nexus/infra/api/aaa/v4/logindomains/{specDomain} - Delete a login domain
GET /nexus/infra/api/aaa/v4/remoteusers - Get a list of remote user
GET /nexus/infra/api/aaa/v4/remoteusers/{specLoginID} - Get a remote user
GET /nexus/infra/api/aaa/v4/trustedjwtkeys - Get a list of trusted JWT key
POST /nexus/infra/api/aaa/v4/trustedjwtkeys - Create a trusted JWT key
GET /nexus/infra/api/aaa/v4/trustedjwtkeys/{specKeyID} - Get a trusted JWT key
PUT /nexus/infra/api/aaa/v4/trustedjwtkeys/{specKeyID} - Modify a trusted JWT key
DELETE /nexus/infra/api/aaa/v4/trustedjwtkeys/{specKeyID} - Delete a trusted JWT key
GET /nexus/infra/api/aaa/v4/userapikeys - Get a list of user API key
POST /nexus/infra/api/aaa/v4/userapikeys - Create a user API key
GET /nexus/infra/api/aaa/v4/userapikeys/{specUuid} - Get a user API key
PUT /nexus/infra/api/aaa/v4/userapikeys/{specUuid} - Modify a user API key
DELETE /nexus/infra/api/aaa/v4/userapikeys/{specUuid} - Delete a user API key
GET /nexus/infra/api/aaa/v4/userpreferences - Get a list of user preference
GET /nexus/infra/api/aaa/v4/userpreferences/{specLoginID} - Get user preference
PUT /nexus/infra/api/aaa/v4/userpreferences/{specLoginID} - Modify a user preference
GET /nexus/infra/api/audit/v1/records - Get list of Audit Records
GET /nexus/infra/api/audit/v1/records/{metadataID} - Get an Audit Record
GET /nexus/infra/api/eventmonitoring/v1/eventconfigs - Get a list of event configurations being monitored
GET /nexus/infra/api/eventmonitoring/v1/eventrecords - Get a list of event records
GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventconfigs - Get a list of event configurations being monitored
GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventconfigs/{specId} - Get an event configuration
GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventrecords - Get a list of event records
GET /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventrecords/{specMetaName} - Get an event record
PUT /nexus/infra/api/eventmonitoring/v1/namespaces/{namespace}/eventrecords/{specMetaName} - Modify an event 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
DELETE /nexus/infra/api/installer/v1/actions/{metadataID} - Delete an installer action (in case of failed upgrade)
GET /nexus/infra/api/platform/v1/clusters - Get all clusters
GET /nexus/infra/api/platform/v1/clusters/{specName} - Get a cluster
PUT /nexus/infra/api/platform/v1/clusters/{specName} - Modify a cluster
POST /nexus/infra/api/platform/v1/exports - Create backup of the cluster config
DELETE /nexus/infra/api/platform/v1/exports/{key} - Delete a backup file
GET /nexus/infra/api/platform/v1/externalips - Get all external IPs
POST /nexus/infra/api/platform/v1/externalips - Create an external IP
GET /nexus/infra/api/platform/v1/externalips/{specName} - Get an external IP
PUT /nexus/infra/api/platform/v1/externalips/{specName} - Modify an external IP
POST /nexus/infra/api/platform/v1/imports - Import cluster config from a backup file
DELETE /nexus/infra/api/platform/v1/imports/{key} - Delete a an import file
GET /nexus/infra/api/platform/v1/nodes - Get all nodes
GET /nexus/infra/api/platform/v1/nodes/{specName} - Get a node
PUT /nexus/infra/api/platform/v1/nodes/{specName} - Modify a node
DELETE /nexus/infra/api/platform/v1/nodes/{specName} - Delete a node
GET /nexus/infra/api/platform/v1/routes - Get all routes
POST /nexus/infra/api/platform/v1/routes - Create a route
GET /nexus/infra/api/platform/v1/routes/{specDestination} - Get a route
PUT /nexus/infra/api/platform/v1/routes/{specDestination} - Modify a route
DELETE /nexus/infra/api/platform/v1/routes/{specDestination} - Delete a route
GET /nexus/infra/api/platform/v1/syslogsyncs - Get all syslog servers
POST /nexus/infra/api/platform/v1/syslogsyncs - Create a syslog server
GET /nexus/infra/api/platform/v1/syslogsyncs/{specAddress} - Get a syslog server
PUT /nexus/infra/api/platform/v1/syslogsyncs/{specAddress} - Modify a syslog server
DELETE /nexus/infra/api/platform/v1/syslogsyncs/{specAddress} - Delete a syslog server
Release 2.2.1 (2022-05-08)
For additional information about the release, see the Release Notes.
There are no API changes in this release.