Northflank

https://northflank.com/docs/v1/
Admin
Northflank is a unified platform for deploying and managing applications, databases, and cron jobs...
Tokens:4,319,769
Snippets:14,836
Trust Score:9.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### API Example Response: List preview blueprints

Source: https://northflank.com/docs/v1/api/project/preview-blueprints/list-preview-blueprints.md

Example 200 OK response for GET /v1/projects/{projectId}/preview-blueprints and GET /v1/teams/{teamId}/projects/{projectId}/preview-blueprints. Shows a list of preview blueprints with workflow details and pagination information.

```json
{
  "data": {
    "workflows": [
      {
        "name": "Example Template",
        "description": "This is a sample template.",
        "apiVersion": "v1.2",
        "options": {
          "autorun": false,
          "concurrencyPolicy": "allow"
        },
        "id": "example-workflow"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}
```

--------------------------------

### API Response Example: Get Credit Balance

Source: https://northflank.com/docs/v1/api/org/billing/get-credit-balance.md

Example JSON response for the GET /v1/billing/credit-balance endpoint, showing the currency field.

```json
{
  "data": {
    "currency": "usd"
  }
}
```

--------------------------------

### Go example to initialize a project

Source: https://northflank.com/docs/v1/api/project/projects/initialize-project.md

Sends a POST request using the net/http package with a JSON body and prints the response status, headers, and body.

```go
package main

import (
  "bytes"
  "fmt"
  "io/ioutil"
  "net/http"
)

func main() {
  url := "https://api.northflank.com/v1/projects/{projectId}/initialize"

  var jsonStr = []byte(`{"region":"europe-west","clusterId":"gcp-cluster-1"}`)
  req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonStr))
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("Authorization", "Bearer NORTHFLANK_API_TOKEN")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println("Response status:", resp.Status)
  fmt.Println("Response headers:", resp.Header)
  body, _ := ioutil.ReadAll(resp.Body)
  fmt.Println("Response body:", string(body))
}
```

--------------------------------

### Start job build example response (JSON)

Source: https://northflank.com/docs/v1/api/jobs/start-job-build

Example response with status 200 OK, returning data about the initiated build, including id, branch, sha, createdAt, status, and concluded.

```json
{
  "data": {
    "id": "joyous-view-6290",
    "branch": "main",
    "sha": "12c15e7ee25fd78f567ebf87f9178b8ad70025b3",
    "createdAt": "2021-07-28T15:55:38.296Z",
    "status": "PENDING",
    "concluded": false
  }
}
```

--------------------------------

### CLI Response Example: Get Credit Balance

Source: https://northflank.com/docs/v1/api/org/billing/get-credit-balance.md

Example JSON response for the northflank get credit-balance command, showing the currency field.

```json
{
  "currency": "usd"
}
```

--------------------------------

### CLI example response (JSON)

Source: https://northflank.com/docs/v1/api/project/projects/initialize-project.md

Example response from the CLI showing the initialized project details, including networking configuration and lifecycle status.

```json
{
  "id": "example-project",
  "name": "New Project",
  "description": "This is a new project.",
  "color": "#EF233C",
  "region": "europe-west",
  "clusterId": "gcp-cluster-1",
  "networking": {
    "tailscale": {
      "restrictions": {
        "tagMatchCondition": "or"
      },
      "tailscaleOptions": {
        "tailnetServicesRestrictions": {
          "tagMatchCondition": "or"
        }
      }
    },
    "hostAliases": {
      "restrictions": {
        "tagMatchCondition": "or"
      }
    }
  },
  "lifecycleStatus": "creating",
  "createdAt": "2000-01-01T12:00:00.000Z",
  "updatedAt": "2000-01-01T12:00:00.000Z"
}
```

--------------------------------

### API Example Response (200 OK)

Source: https://northflank.com/docs/v1/api/team/integrations/list-ssh-identities.md

Example response for GET /v1/integrations/ssh-identities and GET /v1/teams/{teamId}/integrations/ssh-identities. Shows a list of SSH identities with pagination.

```json
{
  "data": {
    "identities": [
      {
        "id": "example-identity",
        "name": "Example SSH Identity",
        "sshPublicKeys": [
          {
            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."
          }
        ],
        "restrictions": {
          "projects": {
            "enabled": false
          },
          "tags": {
            "enabled": false,
            "matchCondition": "or"
          }
        }
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}
```

--------------------------------

### CLI Example Response (northflank get pipeline)

Source: https://northflank.com/docs/v1/api/project/pipelines/get-pipeline.md

Example response for the CLI command `northflank get pipeline`. Shows the pipeline name and its nfObjects array.

```json
{
  "name": "example-pipeline",
  "nfObjects": [
    {
      "id": "example-service",
      "type": "service",
      "stage": "Production"
    }
  ]
}
```

--------------------------------

### Start service build with Go

Source: https://northflank.com/docs/v1/api/project/services/start-service-build.md

Creates an HTTP POST request with the same payload and headers, sends it, and prints the response status, headers, and body. Uses the net/http and ioutil packages.

```go
package main

import (
  "bytes"
  "fmt"
  "io/ioutil"
  "net/http"
)

func main() {
  url := "https://api.northflank.com/v1/projects/{projectId}/services/{serviceId}/build"

  var jsonStr = []byte(`{"bundleUrl":"https://example.com/archive.tar","overrides":{"buildArguments":{"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"},"buildFiles":{"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}},"dockerSecretMounts":{"example-secret-mount_1":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}},"docker":{"dockerFilePath":"/Dockerfile","dockerWorkDir":"/"}}}`)
  req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonStr))
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("Authorization", "Bearer NORTHFLANK_API_TOKEN")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println("Response status:", resp.Status)
  fmt.Println("Response headers:", resp.Header)
  body, _ := ioutil.ReadAll(resp.Body)
  fmt.Println("Response body:", string(body))
}
```

--------------------------------

### Run Preview Blueprint - Go Example

Source: https://northflank.com/docs/v1/api/project/preview-blueprints/run-preview-blueprint.md

Use this Go example to create a preview blueprint run using the net/http package. It constructs a request with a JSON body and prints the response status, headers, and body. Replace the URL placeholders and set NORTHFLANK_API_TOKEN.

```go
package main

import (
  "bytes"
  "fmt"
  "io/ioutil"
  "net/http"
)

func main() {
  url := "https://api.northflank.com/v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs"

  var jsonStr = []byte(`{"name":"Example Run","description":"This is a description for the preview blueprint run.","arguments":{"ARG_1":"value"},"triggers":{"example-trigger":{"branch":"devel"}}}`)
  req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonStr))
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("Authorization", "Bearer NORTHFLANK_API_TOKEN")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println("Response status:", resp.Status)
  fmt.Println("Response headers:", resp.Header)
  body, _ := ioutil.ReadAll(resp.Body)
  fmt.Println("Response body:", string(body))
}
```

--------------------------------

### CLI response example for northflank get job run

Source: https://northflank.com/docs/v1/api/project/jobs/get-run-details.md

Example response from the CLI command `northflank get job run`. Contains job run details without the `data` wrapper.

```json
{
  "id": "d34582a4-35bd-4c71-8e7c-e36999b88723",
  "active": 0,
  "backoffLimit": 0,
  "completions": 1,
  "concluded": true,
  "failed": 0,
  "runName": "example-job-5fcf67bc56e1913e21d49504",
  "status": "SUCCESS",
  "succeeded": 0,
  "startedAt": "2020-12-08T11:47:08Z",
  "concludedAt": "2020-12-08T11:52:08Z"
}
```

--------------------------------

### Example 200 OK response for initialize project

Source: https://northflank.com/docs/v1/api/project/projects/initialize-project.md

Shows the JSON response structure returned on successful initialization, including project details, networking configuration, and lifecycle status.

```json
{
  "data": {
    "id": "example-project",
    "name": "New Project",
    "description": "This is a new project.",
    "color": "#EF233C",
    "region": "europe-west",
    "clusterId": "gcp-cluster-1",
    "networking": {
      "tailscale": {
        "restrictions": {
          "tagMatchCondition": "or"
        },
        "tailscaleOptions": {
          "tailnetServicesRestrictions": {
            "tagMatchCondition": "or"
          }
        }
      },
      "hostAliases": {
        "restrictions": {
          "tagMatchCondition": "or"
        }
      }
    },
    "lifecycleStatus": "creating",
    "createdAt": "2000-01-01T12:00:00.000Z",
    "updatedAt": "2000-01-01T12:00:00.000Z"
  }
}
```

--------------------------------

### API Example Response: List notification integrations

Source: https://northflank.com/docs/v1/api/org/integrations/list-notification-integrations.md

Example 200 OK response for GET /v1/integrations/notifications or GET /v1/teams/{teamId}/integrations/notifications. Shows a notification integration with type RAW_WEBHOOK and pagination details.

```json
{
  "data": {
    "notificationIntegrations": [
      {
        "name": "Example Notification",
        "id": "example-notification",
        "type": "RAW_WEBHOOK",
        "webhook": "https://example.com/webhooks",
        "status": {
          "disabled": false
        },
        "createdAt": "2023-09-12T16:39:44.166Z\"",
        "updatedAt": "2023-09-12T16:39:44.166Z\""
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}
```

--------------------------------

### Get DNS ID API response

Source: https://northflank.com/docs/v1/api/team/miscellaneous/get-dns-id.md

Example response from the GET /v1/dns-id or GET /v1/teams/{teamId}/dns-id endpoint. Returns the DNS ID string.

```json
{
  "data": {
    "dns": "exam-1234"
  }
}
```

--------------------------------

### Create Deployment Service Example Response

Source: https://northflank.com/docs/v1/api/project/services/create-deployment-service.md

Example response returned after creating a service, showing the service details including name, description, billing, and ports.

```json
{
  "name": "Example Service",
  "description": "A service description",
  "billing": {
    "deploymentPlan": "nf-compute-20"
  },
  "ports": [
    {
      "name": "p01",
      "internalPort": 8080,
      "public": true,
      "vpcAccessible": false,
      "security": {
        "credentials": [
          {
            "username": "admin",
            "password": "password123",
            "type": "basic-auth"
          }
        ],
        "ip": [
          {
            "addresses": [
              "127.0.0.1"
            ],
            "action": "DENY"
          }
        ],
        "policies": [
          {
            "addresses": [
              "127.0.0.1"
            ],
            "action": "DENY"
          }
        ],
        "headers": [
          {
            "regexMode": false,
            "name": "headerName",
            "value": "headerValue"
          }
        ],
        "securePathConfiguration": {
          "rules": [
            {
              "paths": [
                {
                  "routingMode": "prefix",
                  "priority": 80,
                  "path": "/path"
                }
              ],
              "accessMode": "protected",
              "securityPolicies": {
                "orPolicies": {
                  "credentials": [
                    {
                      "username": "admin",
                      "password": "password123",
                      "type": "basic-auth"
                    }
                  ],
                  "ip": [
                    {
                      "addresses": [
                        "127.0.0.1"
                      ],
                      "action": "DENY"
                    }
                  ],
                  "policies": [
                    {
                      "addresses": [
                        "127.0.0.1"
                      ],
                      "action": "DENY"
                    }
                  ],
                  "headers": [
                    {
                      "regexMode": false,
                      "name": "headerName",
                      "value": "headerValue"
                    }
                  ]
                },
                "requiredPolicies": {
                  "credentials": [
                    {
                      "username": "admin",
                      "password": "password123",
                      "type": "basic-auth"
                    }
                  ],
                  "ip": [
                    {
                      "addresses": [
                        "127.0.0.1"
                      ],
                      "action": "DENY"
                    }
                  ],
                  "policies": [
                    {
                      "addresses": [
                        "127.0.0.1"
                      ],
                      "action": "DENY"
                    }
                  ],
                  "headers": [
                    {
                      "regexMode": false,
                      "name": "headerName",
                      "value": "headerValue"
                    }
                  ]
                }
              }
            }
          ]
        }
      },
      "domains": [
        "app.example.com"
      ],
      "protocol": "HTTP"
    }
  ]
}
```

--------------------------------

### Example response for running preview environment pipeline

Source: https://northflank.com/docs/v1/api/project/pipelines/run-preview-environment.md

Example 200 OK response containing details about the preview template run, including the template name, description, API version, spec, teardown spec, ID, gitops configuration, and concurrency policy.

```json
{
  "data": {
    "name": "Example Template",
    "description": "This is a sample template.",
    "apiVersion": "v1.2",
    "spec": {
      "kind": "Workflow"
    },
    "teardownSpec": {
      "spec": {
        "kind": "Workflow"
      }
    },
    "id": "example-template",
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile",
      "templateSha": "8c7e040ee3737ddc3a713363ae72bbe960e9fb16"
    },
    "concurrencyPolicy": "allow"
  }
}
```
Tokens:
Raw