Skip to main content
The s3 command manages S3 buckets.

​
create

The create subcommand creates a new S3 bucket record by specifying its connection details. 
nx1 s3 create \
  --bucket <bucket_name> \
  --endpoint <s3_endpoint> \
  --access-key <access_key> \
  --secret-key <secret_key>
  • --access-key string required: Access key for the S3 bucket.
  • --bucket string required: Name of the S3 bucket.
  • --endpoint string required: URL of the S3 endpoint.
  • --secret-key string required: Secret key for the S3 bucket.
  • --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.

​
delete

The delete subcommand deletes an existing S3 bucket from the system. 
nx1 s3 delete bucket_name
  • bucket_name string required: Unique name of the S3 bucket to retrieve.
  • --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.

​
get

The get subcommand retrieves details about a specific S3 bucket. 
nx1 s3 get bucket_name
  • bucket_name string required: Unique name of the S3 bucket to retrieve.
  • --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 retrieves a list of all S3 bucket records. 
nx1 s3
nx1 s3 list
  • --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.

​
refresh

The refresh subcommand manually refreshes all S3 buckets. 
nx1 s3 refresh
  • --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.