NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Northflank connects to a Nagent workspace with an API key. Once it is connected, agents can call 20 Northflank actions, such as "Create or Update Project", "Create or Update Secret" and "Create Secret". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Northflank, with input parameters and output schema.
NORTHFLANK_CREATE_OR_UPDATE_PROJECTTool to create a new project or update an existing project in Northflank (upsert operation). Use when you need to ensure a project exists with specific configuration, regardless of whether it's already created.
Input parameters
The unique identifier for the project. Used to determine if the project should be created or updated
The name of the project
The color of the project in the Northflank App (hex color format: #RRGGBB or #RGB)
The region where the project will be hosted
Advanced project networking settings.
The description of the project (max length: 200 characters)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_CREATE_OR_UPDATE_SECRETTool to create or update a secret group in a Northflank project. Use when you need to store encrypted runtime variables or build arguments that can be inherited by services and jobs.
Input parameters
Unique identifier for the secret group
Display name for the secret group
Priority order for secret inheritance. Higher numbers indicate higher priority
The unique identifier of the project where the secret will be created or updated
Key-value pairs of secret variables to store. Keys are variable names and values are the secret values
Type of secret. Common values include 'environment-variables', 'environment', 'files'
Description of the secret group's purpose
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_CREATE_SECRETTool to create a secret group in a Northflank project. Use when you need to store encrypted environment variables that can be inherited by services and jobs.
Input parameters
Unique identifier for the secret group
Display name for the secret group
Priority order for secret inheritance. Higher numbers indicate higher priority
The unique identifier of the project where the secret will be created
Key-value pairs of secret variables to store. Keys are variable names and values are the secret values. Keys may only contain letters, numbers, hyphens, forward slashes and dots
Type of secret. Common values include 'environment-variables', 'environment', 'files'
Description of the secret group's purpose
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_DELETE_PROJECTTool to permanently delete a Northflank project and all associated resources. Use when you need to remove a project including all builds, deployments, jobs, addons, secret groups, and configurations.
Input parameters
The unique identifier of the project to delete. This operation permanently deletes the project and all associated resources.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_GET_DNS_IDTool to retrieve the DNS identifier for the authenticated account. Use when you need to get the DNS ID used for generating DNS entries for services and domains.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_GET_PROJECTTool to retrieve detailed information about a specific Northflank project. Use when you need to get project configuration, region, networking settings, or metadata.
Input parameters
The unique identifier of the project to retrieve information about
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_GET_SECRETTool to retrieve a secret from a Northflank project including its contents. Use when you need to view the actual secret values and metadata for a specific secret.
Input parameters
The unique identifier of the secret to retrieve
The unique identifier of the project containing the secret
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_GET_SECRET_DETAILSTool to view a secret with details about its linked addons from a Northflank project. Use when you need to understand addon dependencies and detailed metadata for a specific secret.
Input parameters
The unique identifier of the secret to retrieve details for
The unique identifier of the project containing the secret
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_ADDON_TYPESTool to retrieve information about available addon types in Northflank. Use when you need to understand what addon types are supported and their features.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_CLOUD_PROVIDER_NODE_TYPESTool to retrieve supported cloud provider node types available on Northflank. Use when you need to see available node types across various cloud providers including AWS, GCP, Azure, Civo, Oracle Cloud, and CoreWeave.
Input parameters
Page number for pagination
Cursor for cursor-based pagination to retrieve the next page of results
Number of results per page (default: 50)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_CLOUD_PROVIDER_REGIONSTool to retrieve supported cloud provider regions available on Northflank. Use when you need to see available regions across various cloud providers including AWS, GCP, Azure, Civo, Oracle Cloud, and CoreWeave.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_PIPELINESTool to list all pipelines for a Northflank project. Use when you need to retrieve all pipelines configured in a project.
Input parameters
Page number for pagination
Cursor for cursor-based pagination
Number of results per page (default: 50)
The unique identifier of the project to list pipelines for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_PLANSTool to retrieve available billing/resource plans in Northflank. Use when you need to see available plan options and their specifications.
Input parameters
Page number for pagination
Cursor for cursor-based pagination to retrieve the next page of results
Number of results per page (default: 50)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_PROJECTSTool to list all projects in your Northflank team with pagination support. Use when you need to retrieve projects for the authenticated user or team.
Input parameters
Cursor for cursor-based pagination to retrieve the next page of results. This value is returned in the pagination object of the previous response.
Number of results to return per page. Default is 50, maximum is 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_REGIONSTool to retrieve available project regions in Northflank. Use when you need to see which geographic regions are available for deploying projects and resources.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_SECRETSTool to list all secrets belonging to a Northflank project. Use when you need to retrieve secret groups configured in a project. Supports cursor-based pagination with default 50 results per page.
Input parameters
The page number to access
Cursor returned from the previous page of results, used to request the next page. Used for cursor-based pagination.
Number of results per page (default: 50, maximum: 100)
The unique identifier of the project to retrieve secrets from
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_LIST_SERVICESTool to list all services belonging to a Northflank project. Use when you need to retrieve services configured in a project. Supports cursor-based pagination with 50 results per page.
Input parameters
Cursor returned from the previous page of results, used to request the next page. Used for cursor-based pagination.
The unique identifier of the project to retrieve services from
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_PATCH_SECRETTool to partially update a secret group in a Northflank project. Use when you need to modify specific properties of an existing secret without providing all fields.
Input parameters
Display name for the secret group
Priority order for secret inheritance. Higher numbers indicate higher priority
The unique identifier of the secret group to update
The unique identifier of the project containing the secret group
Key-value pairs of secret variables to update. Keys are variable names (must contain only letters, numbers, hyphens, forward slashes, and dots) and values are the secret values
Type of secret. Common values include 'environment-variables', 'environment', 'files'
Description of the secret group's purpose
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_UPDATE_PROJECTTool to update a project in Northflank. Use when you need to modify project settings such as description, color, or advanced networking configuration.
Input parameters
The color of the project in hex format (e.g., #3B82F6)
ID of the project to update
Advanced project networking settings.
The description of the project (max length: 200 characters)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NORTHFLANK_UPDATE_SECRETTool to update a secret in a Northflank project. Use when you need to modify existing secret variables or add new variables to an existing secret.
Input parameters
The unique identifier of the secret to update
The unique identifier of the project where the secret exists
Key-value pairs of secret variables to update. Keys are variable names and values are the secret values. This will update existing variables or add new ones
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 20 Northflank actions on Nagent, including "Create or Update Project", "Create or Update Secret" and "Create Secret". Create or Update Project: Create a new project or update an existing project in Northflank (upsert operation). Each action is listed on this page with its input parameters and its output.
Northflank connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create or Update Project takes 3 required inputs: id, name and region. It also takes 3 optional inputs: color, networking and description. It returns data, error and successful.