# Northflank

The self-service developer platform that automates and unifies deployment of any workload, on any cloud, at any scale.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 20
- **Triggers:** 0
- **Slug:** `NORTHFLANK`
- **Version:** 20260312_00

## Tools

### Create or Update Project

**Slug:** `NORTHFLANK_CREATE_OR_UPDATE_PROJECT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier for the project. Used to determine if the project should be created or updated |
| `name` | string | Yes | The name of the project |
| `color` | string | No | The color of the project in the Northflank App (hex color format: #RRGGBB or #RGB) |
| `region` | string | Yes | The region where the project will be hosted |
| `networking` | object | No | Advanced project networking settings. |
| `description` | string | No | The description of the project (max length: 200 characters) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or Update Secret

**Slug:** `NORTHFLANK_CREATE_OR_UPDATE_SECRET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier for the secret group |
| `name` | string | Yes | Display name for the secret group |
| `priority` | integer | Yes | Priority order for secret inheritance. Higher numbers indicate higher priority |
| `projectId` | string | Yes | The unique identifier of the project where the secret will be created or updated |
| `variables` | object | Yes | Key-value pairs of secret variables to store. Keys are variable names and values are the secret values |
| `secretType` | string | Yes | Type of secret. Common values include 'environment-variables', 'environment', 'files' |
| `description` | string | No | Description of the secret group's purpose |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Secret

**Slug:** `NORTHFLANK_CREATE_SECRET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier for the secret group |
| `name` | string | Yes | Display name for the secret group |
| `priority` | integer | Yes | Priority order for secret inheritance. Higher numbers indicate higher priority |
| `projectId` | string | Yes | The unique identifier of the project where the secret will be created |
| `variables` | object | Yes | 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 |
| `secretType` | string | Yes | Type of secret. Common values include 'environment-variables', 'environment', 'files' |
| `description` | string | No | Description of the secret group's purpose |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `NORTHFLANK_DELETE_PROJECT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | string | Yes | The unique identifier of the project to delete. This operation permanently deletes the project and all associated resources. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get DNS ID

**Slug:** `NORTHFLANK_GET_DNS_ID`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `NORTHFLANK_GET_PROJECT`

Tool to retrieve detailed information about a specific Northflank project. Use when you need to get project configuration, region, networking settings, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | string | Yes | The unique identifier of the project to retrieve information about |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Secret

**Slug:** `NORTHFLANK_GET_SECRET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secretId` | string | Yes | The unique identifier of the secret to retrieve |
| `projectId` | string | Yes | The unique identifier of the project containing the secret |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Secret Details

**Slug:** `NORTHFLANK_GET_SECRET_DETAILS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secretId` | string | Yes | The unique identifier of the secret to retrieve details for |
| `projectId` | string | Yes | The unique identifier of the project containing the secret |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Addon Types

**Slug:** `NORTHFLANK_LIST_ADDON_TYPES`

Tool to retrieve information about available addon types in Northflank. Use when you need to understand what addon types are supported and their features.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Cloud Provider Node Types

**Slug:** `NORTHFLANK_LIST_CLOUD_PROVIDER_NODE_TYPES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `cursor` | string | No | Cursor for cursor-based pagination to retrieve the next page of results |
| `per_page` | integer | No | Number of results per page (default: 50) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Cloud Provider Regions

**Slug:** `NORTHFLANK_LIST_CLOUD_PROVIDER_REGIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipelines

**Slug:** `NORTHFLANK_LIST_PIPELINES`

Tool to list all pipelines for a Northflank project. Use when you need to retrieve all pipelines configured in a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `cursor` | string | No | Cursor for cursor-based pagination |
| `per_page` | integer | No | Number of results per page (default: 50) |
| `projectId` | string | Yes | The unique identifier of the project to list pipelines for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Plans

**Slug:** `NORTHFLANK_LIST_PLANS`

Tool to retrieve available billing/resource plans in Northflank. Use when you need to see available plan options and their specifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `cursor` | string | No | Cursor for cursor-based pagination to retrieve the next page of results |
| `per_page` | integer | No | Number of results per page (default: 50) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `NORTHFLANK_LIST_PROJECTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor for cursor-based pagination to retrieve the next page of results. This value is returned in the pagination object of the previous response. |
| `per_page` | integer | No | Number of results to return per page. Default is 50, maximum is 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Regions

**Slug:** `NORTHFLANK_LIST_REGIONS`

Tool to retrieve available project regions in Northflank. Use when you need to see which geographic regions are available for deploying projects and resources.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Secrets

**Slug:** `NORTHFLANK_LIST_SECRETS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number to access |
| `cursor` | string | No | Cursor returned from the previous page of results, used to request the next page. Used for cursor-based pagination. |
| `per_page` | integer | No | Number of results per page (default: 50, maximum: 100) |
| `projectId` | string | Yes | The unique identifier of the project to retrieve secrets from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Services

**Slug:** `NORTHFLANK_LIST_SERVICES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned from the previous page of results, used to request the next page. Used for cursor-based pagination. |
| `projectId` | string | Yes | The unique identifier of the project to retrieve services from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Secret

**Slug:** `NORTHFLANK_PATCH_SECRET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Display name for the secret group |
| `priority` | integer | No | Priority order for secret inheritance. Higher numbers indicate higher priority |
| `secretId` | string | Yes | The unique identifier of the secret group to update |
| `projectId` | string | Yes | The unique identifier of the project containing the secret group |
| `variables` | object | No | 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 |
| `secretType` | string | No | Type of secret. Common values include 'environment-variables', 'environment', 'files' |
| `description` | string | No | Description of the secret group's purpose |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `NORTHFLANK_UPDATE_PROJECT`

Tool to update a project in Northflank. Use when you need to modify project settings such as description, color, or advanced networking configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `color` | string | No | The color of the project in hex format (e.g., #3B82F6) |
| `projectId` | string | Yes | ID of the project to update |
| `networking` | object | No | Advanced project networking settings. |
| `description` | string | No | The description of the project (max length: 200 characters) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Secret

**Slug:** `NORTHFLANK_UPDATE_SECRET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secretId` | string | Yes | The unique identifier of the secret to update |
| `projectId` | string | Yes | The unique identifier of the project where the secret exists |
| `variables` | object | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |