Northflank API

Gets information about the available addon types

Returns the partially random string used when generating host names for the authenticated account.

The number of results to display per request. Maximum of 100 results per page.

per_page

page

The cursor returned from the previous page of results, used to request the next page.

cursor

A list of domains registered to this account.

The domain is not valid, possibly because it is too long.

The domain is already registered with this account.

Deletes a domain and each of its registered subdomains.

domain

The operation was performed successfully.

The subdomain is not valid (possibly because it is too long) or the domain has not been verified.

The subdomain has already been added to this domain.

subdomain

The default (empty) subdomain cannot be deleted.

Removes a subdomain from its assigned service

Assigns a service port to the given subdomain

Lists projects for the authenticated user or team.

A list of projects for the authenticated user

Delete the given project. Fails if the project isn't empty.

projectId

The project couldn't be deleted as it has dependencies that have not been deleted

Gets a list of addons belonging to the project

A list of addons belonging to the project.

addonId

Returns a list of backups for the given addon.

backupId

Gets details about a given backup including restore history

Generates a temporary download link for downloading the given backup.

Restores the given addon to the given backup state.

Gets a list of containers for the given addon.

Returns the credentials for connecting to the given addon.

Imports a database from an external archive or existing live database.

Updates the network settings for the addon.

Modifies the allocated resources for the given addon.

Updates the security rules for the addon.

Gets details about the current addon version including available upgrades and upgrade history.

Details about the current version of the addon.

Gets a list of jobs belonging to the project

Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client.

jobId

Gets information about the branches of the given job.

Data about the service's available branches.

Returns a list of builds for the given service.

Start a new build for the given job. Given a commit sha, it will build that commit.

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.

Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed.

show

Get details about the build arguments accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'

Details of the build arguments of the job.

Updates the build options for a given job.

Updates the version control source for a given job.

buildId

Sets the Docker CMD override for the given job.

Gets a list of containers for the given job.

Gets information about the deployment of the given job.

Updates the deployment settings of the given job.

Returns the environment variables 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.

Sets the environment variables for the given job.

Get details about the environment variables accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'

Details of the environment variables of the service.

Lists the health checks for the given job.

Details about the health checks for the service.

Gets information about the pull-requests of the given job.

Data about the service's available pull requests.

runId

Gets a list of secrets belonging to the project

Creates a secret with the specified payload

There is already a secret with the same derived identifier

secretId

Details about the link between the secret group and addon.

Link an addon to the secret group or edit the settings of the linked addon.

View a secret with details about its linked addons

The secret with details about its linked addons.

Gets a list of services belonging to the project

There is already a service with the same derived identifier

serviceId

Gets information about the given service.

Gets information about the branches of the given service.

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.

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.

Sets the build arguments for the given service.

Details of the build arguments of the service.

Updates the build options for a given service.

Updates the version control source for a given build or combined service.

Sets the Docker CMD override for the given service.

Gets a list of containers for the given service.

Gets information about the deployment of the given service.

Updates the deployment settings of the given service.

Gets the environment variables 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.

The environment variables of the service.

Sets the environment variables for the given service.

Get details about the environment variables accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'

Lists the health checks for the given service.

Updates health checks for the given service.

Updates the list of ports for the given service.

One of the provided domains has not been registered to this account.

Gets information about the pull-requests of the given service.

Resumes the given service. Optionally takes `instances` to resume with a given number of instances.

The service could not be resumed as it is already paused.

Modifies the scaling settings for the given service.

Gets a list of volumes belonging to the project

Creates a volume with the specified payload

There is already a volume with the same derived identifier

Deletes this volume and its associated data.

volumeId

Lists the container registry credentials saved to this account. Does not display secrets.

A list of registry credentials saved to this account.

Adds a new set of container registry credentials to this account.

Data about the newly created credentials.

Deletes a set of registry credential data.

credentialId

Updates a set of registry credential data.

Details about the version control providers available for use.

Gets a list of repositories accessible to this account

If provided, only returns repositories belonging to this version control provider.

vcs_service

If provided, only returns repositories belonging to this self-hosted version control provider.

self_hosted_vcs_id

If provided, only returns repositories that can be accessed by the linked version control account with this name.

Health check