Subcommands293 subcommands
northflank forward
Port-forwarding for Northflank services and addons
northflank forward all
Port-forwarding for all services and addons in the given project
northflank forward service
Port-forwarding for the specified service
northflank forward addon
Port-forwarding for the specified addon
northflank forward help
Display help for command
northflank command-exec
Command execution (exec) for Northflank services and jobs
northflank command-exec service
Command exec for the specified service
northflank command-exec job
Command exec for the specified job
northflank command-exec help
Display help for command
northflank login
Connect the CLI to your Northflank account
northflank context
Retrieve and update local context settings
northflank context ls
List all available contexts
northflank context use
Switch between your local contexts
northflank context use project
Change the default project in the current local context
northflank context use job
Change the default job in the current local context
northflank context use service
Change the default service in the current local context
northflank context use help
Display help for command
northflank context remove
Remove a context
northflank context update-token
Update token for current context
northflank context help
Display help for command
northflank list
List Northflank resources
northflank list projects
Lists projects for the authenticated user or team
northflank list addons
Gets a list of addons belonging to the project
northflank list invoices
Get a list of past invoices
northflank list providers
Lists supported cloud providers
northflank list integrations
Lists integrations for the authenticated user or team
northflank list clusters
Lists clusters for the authenticated user or team
northflank list jobs
Gets a list of jobs belonging to the project
northflank list log-sinks
Gets a list of log sinks added to this account
northflank list registries
Lists the container registry credentials saved to this account. Does not display secrets
northflank list domains
Lists available domains
northflank list plans
Lists available billing plans
northflank list regions
Lists available project regions
northflank list vcs
Lists linked version control providers
northflank list pipelines
Lists all pipelines for a project
northflank list release-flow-runs
Lists runs of a release flow
northflank list secrets
Gets a list of secrets belonging to the project
northflank list services
Gets a list of services belonging to the project
northflank list templates
Get a list of templates
northflank list template-runs
Get a list of template runs
northflank list repos
Gets a list of repositories accessible to this account
northflank list branches
Gets a list of branches for the repo
northflank list volumes
Gets a list of volumes belonging to the project
northflank list help
Display help for command
northflank create
Create Northflank resources
northflank create project
Creates a new project
northflank create addon
Creates a new addon
northflank create addon backup-schedule
Create a new backup schedule for an addon
northflank create addon help
Display help for command
northflank create integration
Creates a new integration
northflank create cluster
Creates a new cluster
northflank create job
Job Northflank resources
northflank create job manual
Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client
northflank create job cron
Creates a new cron job
northflank create job help
Display help for command
northflank create log-sink
Creates a new log sink
northflank create domain
Registers a new domain
northflank create secret
Creates a secret with the specified payload
northflank create service
Service Northflank resources
northflank create service combined
Creates a new combined service
northflank create service deployment
Creates a new deployment service
northflank create service build
Creates a new build service
northflank create service help
Display help for command
northflank create custom-vcs
CustomVcs Northflank resources
northflank create custom-vcs token
Generate a token for a specific VCS link
northflank create custom-vcs help
Display help for command
northflank create volume
Creates a volume with the specified payload
northflank create help
Display help for command
northflank get
Get information about Northflank resources
northflank get project
Get information about the given project
northflank get addon
Gets information about the given addon
northflank get addon credentials
Returns the credentials for connecting to the given addon
northflank get addon logs
Get log for the specified addon
northflank get addon metrics
Get metrics for the specified addon
northflank get addon types
Gets information about the available addon types
northflank get addon version
Gets details about the current addon version including available upgrades and upgrade history
northflank get addon backups
Returns a list of backups for the given addon
northflank get addon backup
Gets details about a given backup
northflank get addon backup download
Generates a temporary download link for downloading the given backup
northflank get addon backup help
Display help for command
northflank get addon restores
Gets a list of restores for the given backup
northflank get addon containers
Gets a list of containers for the given addon
northflank get addon backup-schedules
Gets details about an addon's backup schedules
northflank get addon pitr-window
Gets the valid window for performing a point-in-time restore (PITR) on this addon
northflank get addon help
Display help for command
northflank get invoice
Get information about Northflank invoices
northflank get invoice details
Get details about an invoice. If `timestamp` is passed in as a query parameter, this endpoint returns details about the invoice containing that timestamp. Otherwise, returns a preview invoice displaying billing data from after the most recent invoice
northflank get invoice help
Display help for command
northflank get integration
Get information about the given integration
northflank get cluster
Get information about the given cluster
northflank get job
Gets information about the given job
northflank get job runs
Fetches run history for the given job
northflank get job logs
Get log for the specified job
northflank get job metrics
Get metrics for the specified job
northflank get job build-logs
Get log for the specified job
northflank get job build-metrics
Get metrics for the specified job
northflank get job run
Returns data about the given job run
northflank get job health-checks
Lists the health checks for the given job
northflank get job builds
Lists builds for the given job
northflank get job build
Gets information about a build for the job
northflank get job build-arguments
Gets the build arguments of the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed
northflank get job build-argument-details
Get details about the build arguments accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'
northflank get job runtime-environment
Returns the runtime environment for the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed
northflank get job runtime-environment-details
Get details about the runtime environment accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'
northflank get job deployment
Gets information about the deployment of the given job
northflank get job containers
Gets a list of containers for the given job
northflank get job branches
Gets information about the branches of the given job
northflank get job pull-requests
Gets information about the pull-requests of the given job
northflank get job help
Display help for command
northflank get log-sink
Gets details about a given log sink
northflank get registry
Views a set of registry credential data
northflank get domain
Gets details about domain
northflank get subdomain
Gets details about the given subdomain
northflank get dns-id
Returns the partially random string used when generating host names for the authenticated account
northflank get pipeline
Get details about a pipeline
northflank get release-flow
Gets details about a release flow
northflank get release-flow-run
Get information about the given release flow run
northflank get secret
View a secret including its contents
northflank get secret-details
View a secret with details about its linked addons
northflank get secret-link
Get details about a given addon link
northflank get service
Gets information about the given service
northflank get service deployment
Gets information about the deployment of the given service
northflank get service logs
Get log for the specified service
northflank get service metrics
Get metrics for the specified service
northflank get service build-logs
Get log for the specified service
northflank get service build-metrics
Get metrics for the specified service
northflank get service ports
Lists the ports for the given service
northflank get service health-checks
Lists the health checks for the given service
northflank get service builds
Lists the builds for the service
northflank get service build
Gets information about a build for the service
northflank get service containers
Gets a list of containers for the given service
northflank get service branches
Gets information about the branches of the given service
northflank get service pull-requests
Gets information about the pull-requests of the given service
northflank get service build-arguments
Gets the build arguments of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed
northflank get service build-argument-details
Get details about the build arguments accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'
northflank get service runtime-environment
Gets the runtime environment of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed
northflank get service runtime-environment-details
Get details about the runtime environment accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'
northflank get service help
Display help for command
northflank get template
Get information about the given template
northflank get template-run
Get information about the given template run
northflank get volume
Retrieve a volume
northflank get help
Display help for command
northflank delete
Delete Northflank resources
northflank delete project
Delete the given project. Fails if the project isn't empty
northflank delete addon
Deletes the given addon
northflank delete addon backup-schedule
Deletes a backup schedule for an addon
northflank delete addon help
Display help for command
northflank delete backup
Deletes a given backup
northflank delete integration
Delete the given integration. Fails if the integration is associated with existing clusters
northflank delete cluster
Delete the given cluster. Fails if the cluster has associated projects
northflank delete job
Deletes the given job
northflank delete log-sink
Deletes a log sink
northflank delete registry
Deletes a set of registry credential data
northflank delete domain
Deletes a domain and each of its registered subdomains
northflank delete subdomain
Removes a subdomain from a domain
northflank delete secret
Delete a secret
northflank delete secret-link
Unlinks an addon from the secret group
northflank delete service
Deletes the given service
northflank delete template
Delete a template
northflank delete volume
Deletes this volume and its associated data
northflank delete help
Display help for command
northflank scale
Scale Northflank resources
northflank scale addon
Modifies the allocated resources for the given addon
northflank scale job
Modifies the scaling settings for the given job
northflank scale service
Modifies the scaling settings for the given service
northflank scale help
Display help for command
northflank update
Update Northflank resource properties
northflank update addon
Update Northflank addon properties
northflank update addon version
Upgrades the addon to a new version
northflank update addon network-settings
Updates the network settings for the addon
northflank update addon security
Updates the security rules for the addon
northflank update addon help
Display help for command
northflank update integration
Update information about the given integration
northflank update cluster
Update an existing cluster
northflank update job
Update Northflank job properties
northflank update job settings
Updates settings for the job
northflank update job health-checks
Updates health checks for the given job
northflank update job build-options
Updates the build options for a given job
northflank update job build-source
Updates the version control source for a given job
northflank update job build-arguments
Sets build arguments for the given job
northflank update job runtime-environment
Sets the runtime environment for the given job
northflank update job deployment
Updates the deployment settings of the given job
northflank update job help
Display help for command
northflank update log-sink
Updates the settings for a log sink
northflank update registry
Updates a set of registry credential data
northflank update release-flow
Updates a release flow
northflank update secret
Update a secret
northflank update secret-link
Link an addon to the secret group or edit the settings of the linked addon
northflank update service
Update Northflank service properties
northflank update service deployment
Updates the deployment settings of the given service
northflank update service ports
Updates the list of ports for the given service
northflank update service build-options
Updates the build options for a given service
northflank update service build-source
Updates the version control source for a given build or combined service
northflank update service health-checks
Updates health checks for the given service
northflank update service build-arguments
Sets the build arguments for the given service
northflank update service runtime-environment
Sets the runtime environment for the given service
northflank update service help
Display help for command
northflank update volume
Update volume mounts and storage size
northflank update help
Display help for command
northflank backup
Backup Northflank resources
northflank backup addon
Initiates a backup for the given addon
northflank backup help
Display help for command
northflank restore
Restore Northflank resources
northflank restore addon
Addon Northflank resources
northflank restore addon backup
Restores the given addon to the given backup state
northflank restore addon help
Display help for command
northflank restore help
Display help for command
northflank import
Import Northflank resources
northflank import addon
Addon Northflank resources
northflank import addon backup
Imports a database from an external archive or existing live database
northflank import addon help
Display help for command
northflank import help
Display help for command
northflank pause
Pause Northflank resources
northflank pause addon
Pause the given addon
northflank pause job
Pause the given job
northflank pause log-sink
Pauses a given log sink
northflank pause service
Pause the given service
northflank pause help
Display help for command
northflank resume
Resume Northflank resources
northflank resume addon
Resume the given addon if it is paused
northflank resume job
Resumes the given job. Optionally takes several arguments to override resumed settings
northflank resume log-sink
Resumes a paused log sink
northflank resume service
Resumes the given service. Optionally takes several arguments to override resumed settings
northflank resume help
Display help for command
northflank restart
Restart Northflank resources
northflank restart addon
Restart the given addon
northflank restart service
Restarts the given service
northflank restart help
Display help for command
northflank abort
Abort Northflank resources
northflank abort addon
Addon Northflank resources
northflank abort addon backup
Aborts the in progress backup
northflank abort addon restore
Aborts an in-progress backup restore
northflank abort addon help
Display help for command
northflank abort job
Job Northflank resources
northflank abort job run
Aborts the given job run
northflank abort job build
Aborts the given job build
northflank abort job help
Display help for command
northflank abort release-flow-run
Abort the given release flow run
northflank abort service
Service Northflank resources
northflank abort service build
Aborts the given service build
northflank abort service help
Display help for command
northflank abort template-run
Abort the given template run
northflank abort help
Display help for command
northflank retain
Retain Northflank resources
northflank retain addon
Addon Northflank resources
northflank retain addon backup
Flags a temporary backup generated by a backup schedule to be retained indefinitely rather than being deleted after the expiry date
northflank retain addon help
Display help for command
northflank retain help
Display help for command
northflank start
Start Northflank resources
northflank start addon
Addon Northflank resources
northflank start addon pitr
Restores an addon to a specific point in time
northflank start addon help
Display help for command
northflank start job
Job Northflank resources
northflank start job run
Starts a new job run for the given job
northflank start job build
Start a new build for the given job. Given a commit sha, it will build that commit
northflank start job help
Display help for command
northflank start service
Service Northflank resources
northflank start service build
Start a new build for the given combined or build service. If given a commit sha, it will build that commit. Otherwise, the most recent relevant commit will be built. If the service provided is a build service, a branch name or pull request to build from is required
northflank start service help
Display help for command
northflank start help
Display help for command
northflank suspend
Suspend Northflank resources
northflank suspend job
Modify cron job to toggle suspending of its schedule
northflank suspend help
Display help for command
northflank add
Add Northflank resources
northflank add registry
Adds a new set of container registry credentials to this account
northflank add domain
Domain Northflank resources
northflank add domain subdomain
Adds a new subdomain to the domain
northflank add domain help
Display help for command
northflank add help
Display help for command
northflank verify
Verify Northflank resources
northflank verify domain
Attempts to verify the domain
northflank verify subdomain
Gets details about the given subdomain
northflank verify help
Display help for command
northflank assign
Assign Northflank resources
northflank assign subdomain
Subdomain Northflank resources
northflank assign subdomain service
Assigns a service port to the given subdomain
northflank assign subdomain help
Display help for command
northflank assign help
Display help for command
northflank unassign
Unassign Northflank resources
northflank unassign subdomain
Removes a subdomain from its assigned service
northflank unassign help
Display help for command
northflank run
Run Northflank resources
northflank run release-flow
Runs a given release flow with given arguments. This endpoint can be used as part of a CI pipeline to automatically trigger a release process
northflank run template
Run a template
northflank run help
Display help for command
northflank attach
Attach Northflank resources
northflank attach volume
Attach a volume
northflank attach help
Display help for command
northflank detach
Detach Northflank resources
northflank detach volume
Detach a volume
northflank detach help
Display help for command
northflank command-overview
Prints a tree view of all available commands
northflank help
Display help for command
