Skip to main content
The apps command manages uploaded DAGs and artifacts.

​
activate

The activate subcommand activates an app. 
nx1 apps activate <version_id>
  • version_id string required: App version ID value.
  • --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.

​
add-dag

The add-dag subcommand adds a DAG component to an app version. You can find the DAGs locally in the /utils/app/{AppName}/{VersionName}/filename directory. 
nx1 apps add-dag \
  --file <file_path> \
  --version-id <version_id>
  • --file string required: File path
  • --name string optional: Filename.
  • --version-id string required: App version ID.
  • --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.

​
components

The components subcommand manages app components. 
nx1 apps components --version-id <app_version_id>
  • --version-id string required: App version ID
  • --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.

​
create

The create subcommand creates a new app. 
nx1 apps create --name <app_name>
  • --name string required: New name for the app.
  • --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.

​
create-version

The create-version subcommand creates a new app version 
nx1 apps create-version --app-id <ID> --name <version_name>
  • --app-id string required: ID of the app.
  • --name string required: Name of the app version.
  • --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 app. 
nx1 apps delete <app_id>
  • app_id string required: ID of the app.
  • --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.

​
deploy

The deploy subcommand deploys a full app deployment. 
nx1 apps deploy \
  --app-name <application_name> \
  --version <app_version_name>
  • --app-name string required: New name for the app.
  • --artifacts string optional: Paths to additional artifacts.
  • --dags string optional: Comma-separated list of DAG Python file paths.
  • --version string required: App version name.
  • --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 gets details about an app resource. 
nx1 apps get <app_id>
  • app_id string required: App ID.
  • --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 app resources. 
nx1 apps 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.

​
roles

The roles subcommand manages app roles. 
nx1 apps roles --app-id <ID>
  • --app-id string required: ID of the app.
  • --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.

​
versions

Lists app versions 
nx1 apps versions --app-id <ID>
  • --app-id string: ID of the app.
  • --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.