v1

Introduction
Use the API
Use the CLI
Use the JavaScript client
Forwarding
Copy files
Execute commands
Log tailing
Retrieve metrics
API reference
Projects
- get
  List projects
- post
  Create project
- put
  Create or update project
- patch
  Update project
- get
  Get project
- delete
  Delete project
Services
- get
  List services
- post
  Create build service
- put
  Put build service
- patch
  Patch build service
- post
  Create combined service
- put
  Put combined service
- patch
  Patch combined service
- post
  Create deployment service
- put
  Put deployment service
- patch
  Patch deployment service
- get
  Get service
- delete
  Delete service
- get
  Get service branches
- get
  List service builds
- post
  Start service build
- get
  Get service build logs
- get
  Get service build metrics
- get
  Get service build
- delete
  Abort service build
- get
  List service containers
- get
  Get service logs
- get
  Get service metrics
- post
  Pause service
- get
  Get service pull requests
- post
  Restart service
- post
  Resume service
- get
  Get service build arguments (deprecated)
- post
  Edit service build arguments (deprecated)
- get
  Get service build arguments details (deprecated)
- post
  Update service build options (deprecated)
- post
  Update service build source (deprecated)
- get
  Get service deployment (deprecated)
- post
  Update service deployment (deprecated)
- get
  Get service health checks (deprecated)
- post
  Update service health checks (deprecated)
- get
  Get service ports (deprecated)
- post
  Update service ports (deprecated)
- get
  Get service runtime environment (deprecated)
- post
  Edit service runtime environment (deprecated)
- get
  Get service runtime environment details (deprecated)
- post
  Scale service (deprecated)
Domains
- get
  List domains
- post
  Create new domain
- get
  Get domain
- delete
  Delete domain
- get
  Get domain certificate
- post
  Import domain certificate
- post
  Add subdomain
- get
  Get subdomain
- delete
  Delete subdomain
- post
  Assign service to subdomain
- delete
  Unassign subdomain
- post
  Remove CDN from a subdomain
- post
  Enable CDN on a subdomain
- post
  Add subdomain path
- get
  List subdomain paths
- get
  Get subdomain path
- delete
  Delete subdomain path
- post
  Update subdomain path
- post
  Assign subdomain path
- delete
  Unassign subdomain path
- post
  Verify subdomain
- post
  Verify domain
Jobs
- get
  List jobs
- post
  Create job
- put
  Put job
- get
  Get job
- patch
  Patch job
- delete
  Delete job
- get
  Get job branches
- get
  List job builds
- post
  Start job build
- get
  Get job build logs
- get
  Get job build metrics
- get
  Get job build
- delete
  Abort job build
- get
  List job containers
- get
  Get job logs
- get
  Get job metrics
- post
  Pause job
- get
  Get job pull requests
- post
  Resume job
- get
  Get job runs
- post
  Run job
- get
  Get run details
- delete
  Abort job run
- post
  Create cron job (deprecated)
- put
  Put cron job (deprecated)
- patch
  Patch cron job (deprecated)
- post
  Create manual job (deprecated)
- put
  Put manual job (deprecated)
- patch
  Patch manual job (deprecated)
- get
  Get job build arguments (deprecated)
- post
  Edit job build arguments (deprecated)
- get
  Get job build argument details (deprecated)
- post
  Update job build options (deprecated)
- post
  Update job build source (deprecated)
- get
  Get job deployment (deprecated)
- post
  Update job deployment (deprecated)
- get
  Get job health checks (deprecated)
- post
  Update job health checks (deprecated)
- get
  Get job runtime environment (deprecated)
- post
  Edit job runtime environment (deprecated)
- get
  Get job runtime environment details (deprecated)
- post
  Scale job (deprecated)
- post
  Update job settings (deprecated)
- post
  Suspend job (deprecated)
Addons
- get
  List addon types
- get
  Get logs for a resource
- get
  List addons
- post
  Create addon
- put
  Put addon
- get
  Get addon
- patch
  Patch addon
- delete
  Delete addon
- get
  Get addon backup schedules
- post
  Create addon backup schedule
- delete
  Delete addon backup schedule
- get
  List addon backups
- post
  Backup addon
- get
  Get addon backup
- delete
  Delete addon backup
- post
  Abort backup
- post
  Abort backup restore
- get
  Get backup download link
- get
  Get addon backup logs
- post
  Restore addon backup
- get
  List addon backup restores
- get
  Get addon restore logs
- post
  Retain backup
- get
  List addon containers
- get
  Get addon credentials
- post
  Import addon backup
- get
  Get addon logs
- get
  Get addon metrics
- post
  Update addon network settings
- post
  Pause addon
- post
  Reset addon
- post
  Restart addon
- get
  List addon restores
- post
  Resume addon
- post
  Update addon security rules
- get
  Get addon version details
- post
  Upgrade addon version
- post
  Scale addon resources (deprecated)
Secrets
- get
  List project secrets
- post
  Create project secret
- put
  Put project secret
- patch
  Patch project secret
- get
  Get project secret
- delete
  Delete project secret
- post
  Update project secret
- post
  Update project secret addon link
- get
  Get project secret addon link details
- get
  Get project secret details
- get
  List global secrets
- post
  Create global secret
- put
  Put global secret
- patch
  Patch global secret
- get
  Get global secret
- delete
  Delete global secret
- delete
  Unlink addon from project secret (deprecated)
Volumes
- get
  List volumes
- post
  Create volume
- get
  Get volume
- post
  Update volume
- delete
  Delete volume
- post
  Attach volume
- get
  Get volume backups
- post
  Backup volume
- get
  Get volume backup details
- delete
  Delete volume backup
- post
  Detach volume
Templates
- get
  List templates
- post
  Create template
- get
  Get template
- post
  Update template
- delete
  Delete template
- post
  Run template
- get
  List template runs
- get
  Get template run
- post
  Abort template run
Workflows
- get
  List workflows
- post
  Create workflow
- get
  Get workflow
- post
  Update workflow
- post
  Run workflow
- get
  List workflow runs
- get
  Get workflow run details
- post
  Abort workflow run
Preview Blueprints
- get
  List preview blueprints
- post
  Create preview blueprint
- get
  Get preview blueprint
- post
  Update preview blueprint
- delete
  Delete preview blueprint
- post
  Run preview blueprint
- get
  List preview blueprint runs
- get
  Get preview blueprint run details
- post
  Abort preview blueprint run
Pipelines
- get
  List pipelines
- get
  Get pipeline
- get
  Get preview template
- post
  Update preview template
- get
  List preview environments
- delete
  Delete preview environment
- post
  Run preview environment
- get
  List preview template runs
- get
  Get preview template run
- get
  Get release flow
- post
  Update release flow
- post
  Run release flow
- get
  List release flow runs
- get
  Get release flow run details
- post
  Abort release flow run
Integrations
- get
  List log sinks
- post
  Create log sink
- get
  Get log sink details
- delete
  Delete log sink
- post
  Pause log sink
- post
  Resume log sink
- post
  Update log sink
- get
  List notification integrations
- post
  Create notification integration
- get
  Get notification integration
- post
  Update notification integration
- delete
  Delete notification integration
- get
  List registries
- post
  Add registry
- get
  Get registry
- patch
  Update registry
- delete
  Delete registry
- get
  List VCS providers
- post
  Generate VCS token
- get
  List repositories
- get
  List branches
Cloud Providers
- get
  List providers
- get
  List clusters
- post
  Create cluster
- put
  Put cluster
- get
  Get cluster
- patch
  Patch cluster
- delete
  Delete cluster
- get
  List cluster nodes
- post
  Cordon cluster node
- post
  Drain cluster node
- post
  Uncordon cluster node
- get
  List integrations
- post
  Create integration
- put
  Put integration
- get
  Get integration
- patch
  Patch integration
- delete
  Delete integration
- get
  List provider node types
- get
  List provider regions
Load Balancers
- get
  List load balancers
- post
  Create load balancer
- put
  Put load balancer
- get
  Get load balancer
- patch
  Patch load balancer
- delete
  Delete load balancer
OpenTofu
- get
  Get OpenTofu job logs
Tags
- get
  List tags
- post
  Add tag
- put
  Put tag
- get
  Get tag
- patch
  Update tag
- delete
  Delete tag
Billing
- get
  List invoices
- get
  Get invoice details
Backup Destinations
- get
  List backup destinations
- post
  Add backup destination
- get
  Get backup destination
- patch
  Patch backup destination
- delete
  Delete backup destination
- get
  List destinations backups
Miscellaneous
- get
  Health check
- get
  Get DNS ID
- get
  List plans
- get
  List regions

Application API & CLI

API

CLI

JS Client

Miscellaneous /

Health check

Returns api service status

API

CLI

JS Client

GET /v1/

Example response

200 OK

success

© 2026 Northflank Ltd. All rights reserved.

northflank.com Terms Privacy feedback@northflank.com