Introduction | Northflank API docs
v1
ApplicationAPI & CLI
Double column

Introduction

Seamlessly build, deploy and scale your code, jobs and databases. Operate your infrastructure in real-time with Northflank’s API, CLI & JavaScript client.

Getting started

Use the Northflank API

Learn how to create and manage projects on Northflank programmatically using the REST API.

Use the Northflank CLI

Learn how to create and manage projects on Northflank using the command line client.

Use the Northflank JavaScript client

Learn how to create and manage projects on Northflank programmatically using the JavaScript client.

What you can do with the Northflank API

Deploy a website or microservice

Create a new deployment in seconds from an image built on Northflank or an external container registry.

Trigger a job run

Run a job with a simple API call. Build a new image for the job or update the environment variables before running.

Build via command line

Trigger a build of any commit to a repository via the command line and deploy it.

Create a database and connect immediately

Create a database addon and retrieve the credentials to begin using it as soon as it's spun up.

Manage secrets

Add groups of build arguments and runtime variables to securely manage secrets for your services. Link credentials from a database or storage addon for immediate and easy access in your project.

Build a managed hosting platform for your OSS or SaaS

Build your own hosting platform on top of Northflank. Include as many Northflank features and options as you want while implementing your own UI, RBAC, billing, or any other features you require. Create, update, and delete projects, services, configurations, and everything else on behalf of your users.

And much, much more...

Northflank is a developer tools sandbox where you can unleash your potential. Programmatically combine features to build whatever you can imagine!

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com