Grant API access

An API token authenticates a user or program to an application programming interface (API). The Northflank API uses JSON Web Tokens (JWT) for authentication.

To create an API token you will first need to create an API role. An API role defines the permissions that a generated token has to access and update resources in your team.

API roles define the permissions granted by the API tokens that you and your team members can generate. You can edit roles after they are created to update permissions in real time.

You can create or edit an API role from the API roles page in your team account .

You must select the users the role is available to. Only the team members added to the role will be able to create API tokens with the role.

Restrict a role to specific projects

You can restrict roles to only allow access to specific projects, or leave unrestricted to grant the permissions to all projects in the team.

Select permissions

Permissions are categorised by team and project. Team permissions grant API tokens access to team administration endpoints, team resources, and cloud provider integrations. Project permissions grant users access to project resource endpoints for projects, services, jobs, addons, pipelines, volumes, secrets, and logs and metrics.

Delete a role

If you delete a role it will revoke all the user tokens generated using the role.

You and other members of your team can generate API tokens from the tokens page in team settings. A user must have an API role available to them to create an API token

Team members that create an API token using the role will be able to view but not modify it, unless they have permission to edit API roles.

To use your API token simply copy the token from either the list or the edit token page and pass it into your application. Your application will now have access to your Northflank projects and services as granted by the token.

important

Never share your API token or commit it to a repository! Tokens should be stored securely.