Skip to main content
The profile command manages multiple credentials used to authenticate and interact with NexusOne.

​
add

The add subcommand add a credential to a profile configuration file. It also updates the credential. 
nx1 profile add \
  --name <profile_name> \
  --api-key <api_key> \
  --host <api_host>
  • --name string required: Name of the profile.
  • --api-key string optional: API key or the NX1_API_KEY variable.
  • --config-file string optional: YAML config file.
  • --help -h optional: Shows help messages and exit.
  • --host string optional: API host.
  • --no-verify-ssl optional: Disables SSL verification.
  • --output -o optional: Output format. Allowed values: json, yaml, or table.
  • --profile -p string optional: Profile name from ~/.nx1/profiles.
  • --timeout integer optional: Requests when to timeout. Default is 30.
  • --verbose -v optional: Verbose output.

​
list

The list subcommand lists credentials in a profile configuration file. 
nx1 profile list --name <profile_name>
  • --name string required: Name of the profile.
  • --api-key string optional: API key or the NX1_API_KEY variable.
  • --config-file string optional: YAML config file.
  • --help -h optional: Shows help messages and exit.
  • --host string optional: API host.
  • --no-verify-ssl optional: Disables SSL verification.
  • --output -o optional: Output format. Allowed values: json, yaml, or table.
  • --profile -p string optional: Profile name from ~/.nx1/profiles.
  • --timeout integer optional: Requests when to timeout. Default is 30.
  • --verbose -v optional: Verbose output.

​
path

The path subcommand lists credentials in a profile configuration file. 
nx1 profile list --name <profile_name>
  • --name string required: Name of the profile.
  • --api-key string optional: API key or the NX1_API_KEY variable.
  • --config-file string optional: YAML config file.
  • --help -h optional: Shows help messages and exit.
  • --host string optional: API host.
  • --no-verify-ssl optional: Disables SSL verification.
  • --output -o optional: Output format. Allowed values: json, yaml, or table.
  • --profile -p string optional: Profile name from ~/.nx1/profiles.
  • --timeout integer optional: Requests when to timeout. Default is 30.
  • --verbose -v optional: Verbose output.

​
remove

The remove subcommand removes a credential from a profile configuration file. 
nx1 profile remove <name>
  • name string required: Unique name of the previously created profile.
  • --api-key string optional: API key or the NX1_API_KEY variable.
  • --config-file string optional: YAML config file.
  • --help -h optional: Shows help messages and exit.
  • --host string optional: API host.
  • --no-verify-ssl optional: Disables SSL verification.
  • --output -o optional: Output format. Allowed values: json, yaml, or table.
  • --profile -p string optional: Profile name from ~/.nx1/profiles.
  • --timeout integer optional: Requests when to timeout. Default is 30.
  • --verbose -v optional: Verbose output.

​
show

The show subcommand shows a credential in a profile configuration file. 
nx1 profile show <name>
  • name string required: Unique name of the previously created profile.
  • --api-key string optional: API key or the NX1_API_KEY variable.
  • --config-file string optional: YAML config file.
  • --help -h optional: Shows help messages and exit.
  • --host string optional: API host.
  • --no-verify-ssl optional: Disables SSL verification.
  • --output -o optional: Output format. Allowed values: json, yaml, or table.
  • --profile -p string optional: Profile name from ~/.nx1/profiles.
  • --timeout integer optional: Requests when to timeout. Default is 30.
  • --verbose -v optional: Verbose output.