NVIDIA NVOS User Manual for InfiniBand Switches v25.02.7002

NVIDIA Docs Hub Homepage NVIDIA Networking Networking Software Switch Software NVIDIA NVOS User Manual for InfiniBand Switches v25.02.7002 System API Commands

On This Page

nv show system api
nv set/unset system api state
nv set/unset system api port
nv set system api compression
nv show system api mtls
nv set system api mtls ca-certificate
nv set system api certificate

System API Commands

nv show system api

	nv show system api Show NVUE external REST API configuration.
Syntax Description	N/A
Default	N/A
History	25.02.2002 25.02.3000 Updated command output
Example	Copy Copied! `admin@nvos:~$ nv show system api operational applied ------------------- ----------- ----------- state enabled enabled port 443 443 certificate cert_id_304 cert_id_304 [listening-address] any mtls ca-certificate ca_id_49 ca_id_49 connections active 1 accepted 1 handled 1 requests 1 reading 0 writing 1 waiting 0`
REST API	GET https://<ip>/nvue_v1/system/api
Related Commands	nv set/unset system api state nv set/unset system api port
Notes

nv set/unset system api state

	nv set/unset system api state < enabled \| disabled> Set the REST API external access state.
Syntax Description	state	enabled, disabled
Default	enabled
History	25.02.2002
Example	Copy Copied! `admin@nvos:~$ nv show system api admin@nvos:~$ nv set system api state enabled`
REST API	PATCH https://<ip>/nvue_v1/system/api
Related Commands	nv show system api
Notes

nv set/unset system api port

	nv set/unset system api port <port-number> Set the REST API listen port.
Syntax Description	port-number	Port number of the remote syslog server: 1–65535
Default	443
History	25.02.2002
Example	Copy Copied! `admin@nvos:~$ nv set system api port 443`
REST API	PATCH https://<ip>/nvue_v1/system/api
Related Commands	nv show system api
Notes

nv set system api compression

	nv set system api compression [gzip] nv unset system api compression Enable compression for NVUE REST API resonse. The unset form of the command disables compression for NVUE REST API resonse.
Syntax Description	gzip	Enables gzip configuration in nginx for NVUED.
Default	N/A
History	25.02.7002
Example	Copy Copied! `admin@nvos:~$ nv set system api compression gzip`
REST API	PATCH https://<ip>/nvue_v1/system/api/?rev=<rev_id> Content-Type: application/json {"compression": "gzip"}
Related Commands
Notes

nv show system api mtls

	nv show system api mtls Show configured CA certificate for API mTLS connections.
Syntax Description	N/A
Default	N/A
History	25.02.2002
Example	Copy Copied! `admin@nvos:~$ nv show system api mtls operational applied -------------- ----------- --------- ca-certificate nvue_root nvue_root`
REST API	GET https://<ip>/nvue_v1/system/api/mtls
Related Commands
Notes	nv show system api

nv set system api mtls ca-certificate

	nv set system api mtls ca-certificate <cacert-id> Set CA certificate for API mTLS connection.
Syntax Description	cacert-id	CA certificate ID string
Default	none
History	25.02.2002
Example	Copy Copied! `admin@nvos:~$ nv set system api mtls ca-certificate nvue_root`
REST API	PATCH https://<ip>/nvue_v1/system/api/mtls?rev= Content-Type: application/json {"ca-certificate": "cacert_id"}
Related Commands
Notes

nv set system api certificate

	nv set system api certificate <cert-id> Set certificate for API connection.
Syntax Description	cert-id	Certificate ID string
Default	none
History	25.02.2002
Example	Copy Copied! `admin@nvos:~$ nv set system api certificate cert cert_id`
REST API	PATCH https://<ip>/nvue_v1/system/api/mtls?rev= Content-Type: application/json {"certificate": "cert_id"}
Related Commands
Notes

© Copyright 2026, NVIDIA. Last updated on Feb 23, 2026