Health check | Miscellaneous | Northflank API docs

v1

Introduction
Use the API
Use the CLI
Use the JavaScript client
Forwarding
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 arguments
- post
  Edit service build arguments
- get
  Get service build arguments details
- get
  Get service build logs
- get
  Get service build metrics
- post
  Update service build options
- post
  Update service build source
- get
  Get service build
- delete
  Abort service build
- get
  List service containers
- get
  Get service deployment
- post
  Update service deployment
- get
  Get service health checks
- post
  Update service health checks
- get
  Get service logs
- get
  Get service metrics
- post
  Pause service
- get
  Get service ports
- post
  Update service ports
- get
  Get service pull requests
- post
  Restart service
- post
  Resume service
- get
  Get service runtime environment
- post
  Edit service runtime environment
- get
  Get service runtime environment details
- post
  Scale service
Domains
- get
  List domains
- post
  Create new domain
- get
  Get domain
- delete
  Delete domain
- 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
  Verify subdomain
- post
  Verify domain
Jobs
- get
  List jobs
- post
  Create cron job
- put
  Put cron job
- patch
  Patch cron job
- post
  Create manual job
- put
  Put manual job
- patch
  Patch manual job
- get
  Get job
- delete
  Delete job
- get
  Get job branches
- get
  List job builds
- post
  Start job build
- get
  Get job build arguments
- post
  Edit job build arguments
- get
  Get job build argument details
- get
  Get job build logs
- get
  Get job build metrics
- post
  Update job build options
- post
  Update job build source
- get
  Get job build
- delete
  Abort job build
- get
  List job containers
- get
  Get job deployment
- post
  Update job deployment
- get
  Get job health checks
- post
  Update job health checks
- 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
- get
  Get job runtime environment
- post
  Edit job runtime environment
- get
  Get job runtime environment details
- post
  Scale job
- post
  Update job settings
- post
  Suspend job
Addons
- get
  List addon types
- 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
  Initiate point-in-time restore
- get
  Get point-in-time restore window
- post
  Reset addon
- post
  Restart addon
- post
  Resume addon
- post
  Scale addon resources
- post
  Update addon security rules
- get
  Get addon version details
- post
  Upgrade addon version
Secrets
- get
  List secrets
- post
  Create secret
- put
  Put secret
- patch
  Patch secret
- get
  Get secret
- delete
  Delete secret
- post
  Update secret
- post
  Update secret addon link
- get
  Get secret addon link details
- delete
  Unlink addon from secret group
- get
  Get secret details
Volumes
- get
  List volumes
- post
  Create volume
- get
  Get volume
- post
  Update volume
- delete
  Delete volume
- post
  Attach volume
- post
  Detach volume
Pipelines
- get
  List pipelines
- get
  Get pipeline
- get
  Get preview template
- post
  Update preview template
- get
  List preview environments
- delete
  Delete 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
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
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
- delete
  Delete registry
- post
  Update 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
- get
  Get cluster
- post
  Update cluster
- delete
  Delete cluster
- get
  List docker registries
- post
  Create docker registry
- get
  Get docker registry
- delete
  Delete registry
- get
  List integrations
- post
  Create integration
- get
  Get integration
- post
  Update integration
- delete
  Delete integration
- get
  List provider node types
- get
  List provider regions
Billing
- get
  List invoices
- get
  Get invoice details
Miscellaneous
- get
  Health check
- get
  Get DNS ID
- get
  List plans
- get
  List regions

Application API & CLI

Double column

API

CLI

JS Client

Miscellaneous /

Health check

Returns api service status

API

CLI

JS Client

GET /v1/

Example response

200 OK

success

© 2024 Northflank Ltd. All rights reserved.

northflank.com Terms Privacy feedback@northflank.com