Northflank

https://northflank.com/docs
Admin
A full-stack cloud platform for building, deploying, and scaling code, jobs, and databases with a...
Tokens:787,671
Snippets:4,226
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example Response for Workload Identity Installation

Source: https://northflank.com/docs/v1/api/team/integrations/install-workload-identity.md

The response returns the current state and configuration details of the workload identity after the installation process has been triggered.

```json
{
  "data": {
    "id": "example-workload-identity",
    "name": "Example Workload Identity",
    "spec": {
      "restrictions": {
        "projects": {
          "enabled": false
        },
        "tags": {
          "enabled": false,
          "matchCondition": "or"
        }
      }
    }
  }
}
```

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

### Start Job Build Request

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

Examples of how to trigger a job build using various programming languages.

```javascript
const payload = {
  "sha": "262ed9817b3cad5142fbceabe0c9e371e390d616",
  "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": "/"
    }
  }
}

const response = await fetch('https://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/build', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${NORTHFLANK_API_TOKEN}`
  },
  body: JSON.stringify(payload)
})

const json = await response.json()
console.log(json)
```

```python
import requests

url = "https://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/build"

payload = {"sha":"262ed9817b3cad5142fbceabe0c9e371e390d616","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":"/"}}}
headers = {"Content-Type": "application/json", "Authorization": "Bearer NORTHFLANK_API_TOKEN"}

response = requests.request("POST", url, headers = headers, json = payload)

print(response.json())
```

```go
package main

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

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

  var jsonStr = []byte(`{"sha":"262ed9817b3cad5142fbceabe0c9e371e390d616","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))
}
```

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

### Get Release Flow Example Response

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

A successful 200 OK response containing the configuration and status of a release flow.

```json
{
  "data": {
    "apiVersion": "v1.2",
    "triggers": [
      {
        "vcsService": "github",
        "accountLogin": "github-user",
        "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
        "pathIgnoreRules": [
          "README.md"
        ],
        "ciIgnoreFlags": [
          "[skip ci]"
        ]
      }
    ],
    "options": {
      "concurrencyPolicy": "allow",
      "paused": false
    },
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile"
    },
    "richInputs": [
      {
        "kind": "BranchCommitSelector",
        "spec": {
          "required": false,
          "inputs": {
            "source": "build-service"
          },
          "outputs": {
            "branch": "TARGET_BRANCH",
            "buildSha": "TARGET_COMMIT"
          }
        }
      }
    ],
    "spec": {
      "kind": "Workflow"
    },
    "teardownSpec": {
      "spec": {
        "kind": "Workflow"
      }
    },
    "concurrencyPolicy": "allow",
    "stage": "Development",
    "status": "success",
    "paused": false,
    "createdAt": "2021-01-01 12:00:00.000Z",
    "updatedAt": "2021-01-01 12:00:00.000Z"
  }
}
```

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

### Create a new template with JavaScript

Source: https://northflank.com/docs/v1/api/team/templates/create-template.md

Use these examples to create a template via the Northflank API. The first example includes a full specification, while the second focuses on GitOps-enabled template creation.

```javascript
await apiClient.create.template({
  data: {
    "name": "Example Template",
    "description": "This is a sample template.",
    "apiVersion": "v1.2",
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile"
    },
    "spec": {
      "kind": "Workflow",
      "spec": {
        "type": "sequential",
        "context": {
          "projectId": "example-project"
        }
      }
    },
    "teardownSpec": {
      "spec": {
        "kind": "Workflow"
      }
    },
    "options": {
      "autorun": false,
      "concurrencyPolicy": "allow",
      "runOnCreation": true
    }
  }
});
```

```javascript
await apiClient.create.template({
  data: {
    "name": "Example Template",
    "description": "This is a sample template.",
    "teardownSpec": {
      "spec": {
        "kind": "Workflow"
      }
    },
    "options": {
      "autorun": false,
      "concurrencyPolicy": "allow",
      "runOnCreation": true
    },
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile"
    }
  }
});
```

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

### Preview Blueprint Response Example

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

A sample JSON response returned by the GET request, containing configuration, triggers, and status metadata.

```json
{
  "data": {
    "apiVersion": "v1.2",
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile"
    },
    "spec": {
      "kind": "Workflow"
    },
    "options": {
      "concurrencyPolicy": "allow",
      "autorun": false
    },
    "triggers": [
      {
        "spec": {
          "vcs": {
            "vcsService": "github",
            "accountLogin": "github-user",
            "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo"
          },
          "commitMessageFlags": {
            "flags": [
              "[skip ci]"
            ]
          },
          "filePaths": {
            "paths": [
              "README.md"
            ]
          }
        }
      }
    ],
    "concurrencyPolicy": "allow",
    "status": "success",
    "paused": false,
    "createdAt": "2021-01-01 12:00:00.000Z",
    "updatedAt": "2021-01-01 12:00:00.000Z"
  }
}
```

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

### Get Tag Example Response

Source: https://northflank.com/docs/v1/api/team/tags/get-tag.md

A successful 200 OK response containing the tag's configuration, including sandboxing settings and node scheduling preferences.

```json
{
  "data": {
    "useAsInfrastructureLabel": false,
    "useSpotNodes": false,
    "useOnDemandNodes": false,
    "sandboxing": {
      "builds": {
        "enabled": false,
        "runtimeClass": "gvisor"
      },
      "services": {
        "enabled": false,
        "runtimeClass": "gvisor"
      },
      "addons": {
        "enabled": false,
        "runtimeClass": "gvisor"
      },
      "jobs": {
        "enabled": false,
        "runtimeClass": "gvisor"
      }
    },
    "color": "#57637A",
    "name": "Example Tag",
    "id": "example-tag",
    "createdAt": "2000-01-01T12:00:00.000Z"
  }
}
```

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

### Example Template Response

Source: https://northflank.com/docs/v1/api/team/templates/get-template.md

A sample response body containing the details of a specific template.

```json
{
  "name": "Example Template",
  "description": "This is a sample template.",
  "apiVersion": "v1.2",
  "spec": {
    "kind": "Workflow",
    "spec": {
      "type": "sequential",
      "context": {
        "projectId": "example-project"
      }
    }
  },
  "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"
}
```

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

### Create a new template

Source: https://northflank.com/docs/v1/api/team/templates/create-template.md

Use these examples to create a new template by sending a POST request to the templates endpoint.

```curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Template","description":"This is a sample template.","apiVersion":"v1.2","gitops":{"vcsService":"github","accountLogin":"github-user","repoUrl":"https://github.com/northflank-examples/remix-postgres-redis-demo","branch":"main","filePath":"/Dockerfile"},"spec":{"kind":"Workflow","spec":{"type":"sequential","context":{"projectId":"example-project"}}},"teardownSpec":{"spec":{"kind":"Workflow"}},"options":{"autorun":false,"concurrencyPolicy":"allow","runOnCreation":true}}' \
  https://api.northflank.com/v1/templates
```

```javascript
const payload = {
  "name": "Example Template",
  "description": "This is a sample template.",
  "apiVersion": "v1.2",
  "gitops": {
    "vcsService": "github",
    "accountLogin": "github-user",
    "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
    "branch": "main",
    "filePath": "/Dockerfile"
  },
  "spec": {
    "kind": "Workflow",
    "spec": {
      "type": "sequential",
      "context": {
        "projectId": "example-project"
      }
    }
  },
  "teardownSpec": {
    "spec": {
      "kind": "Workflow"
    }
  },
  "options": {
    "autorun": false,
    "concurrencyPolicy": "allow",
    "runOnCreation": true
  }
}

const response = await fetch('https://api.northflank.com/v1/templates', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${NORTHFLANK_API_TOKEN}`
  },
  body: JSON.stringify(payload)
})

const json = await response.json()
console.log(json)
```

```python
import requests

url = "https://api.northflank.com/v1/templates"

payload = {"name":"Example Template","description":"This is a sample template.","apiVersion":"v1.2","gitops":{"vcsService":"github","accountLogin":"github-user","repoUrl":"https://github.com/northflank-examples/remix-postgres-redis-demo","branch":"main","filePath":"/Dockerfile"},"spec":{"kind":"Workflow","spec":{"type":"sequential","context":{"projectId":"example-project"}}},"teardownSpec":{"spec":{"kind":"Workflow"}},"options":{"autorun":false,"concurrencyPolicy":"allow","runOnCreation":true}}
headers = {"Content-Type": "application/json", "Authorization": "Bearer NORTHFLANK_API_TOKEN"}

response = requests.request("POST", url, headers = headers, json = payload)

print(response.json())
```

```go
package main

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

func main() {
  url := "https://api.northflank.com/v1/templates"

  var jsonStr = []byte(`{"name":"Example Template","description":"This is a sample template.","apiVersion":"v1.2","gitops":{"vcsService":"github","accountLogin":"github-user","repoUrl":"https://github.com/northflank-examples/remix-postgres-redis-demo","branch":"main","filePath":"/Dockerfile"},"spec":{"kind":"Workflow","spec":{"type":"sequential","context":{"projectId":"example-project"}}},"teardownSpec":{"spec":{"kind":"Workflow"}},"options":{"autorun":false,"concurrencyPolicy":"allow","runOnCreation":true}}`)
  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))
}
```

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

### Template Run Details Response

Source: https://northflank.com/docs/v1/api/team/templates/get-template-run.md

Example of the detailed response object for a template run.

```json
{
  "name": "Example Template",
  "description": "This is a sample template.",
  "apiVersion": "v1.2",
  "options": {
    "autorun": false,
    "concurrencyPolicy": "allow"
  },
  "gitops": {
    "vcsService": "github",
    "accountLogin": "github-user",
    "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
    "branch": "main",
    "filePath": "/Dockerfile"
  },
  "spec": {
    "settings": {
      "maxAttempts": 3,
      "backoff": {
        "type": "fixed",
        "delay": 60
      }
    },
    "kind": "Workflow",
    "response": {
      "status": "success",
      "retries": {
        "attempts": 1,
        "maxAttempts": 3,
        "timestamp": 1657296265
      },
      "startTime": 1657296265,
      "endTime": 1657296265
    }
  },
  "id": "3dd592f6-ce63-45ee-acf8-13dc5ec5235c",
  "templateId": "example-template",
  "status": "success",
  "concluded": true,
  "createdAt": "2021-01-01 12:00:00.000Z",
  "updatedAt": "2021-01-01 12:00:00.000Z"
}
```

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

### Run Template API Requests

Source: https://northflank.com/docs/v1/api/team/templates/run-template.md

Examples for triggering a template run using different programming languages and cURL.

```curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data 'undefined' \
  https://api.northflank.com/v1/templates/{templateId}/runs
```

```javascript
const payload = undefined

const response = await fetch('https://api.northflank.com/v1/templates/{templateId}/runs', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${NORTHFLANK_API_TOKEN}`
  },
  body: JSON.stringify(payload)
})

const json = await response.json()
console.log(json)
```

```python
import requests

url = "https://api.northflank.com/v1/templates/{templateId}/runs"

payload = undefined
headers = {"Content-Type": "application/json", "Authorization": "Bearer NORTHFLANK_API_TOKEN"}

response = requests.request("POST", url, headers = headers, json = payload)

print(response.json())
```

```go
package main

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

func main() {
  url := "https://api.northflank.com/v1/templates/{templateId}/runs"

  var jsonStr = []byte(`undefined`)
  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))
}
```

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

### JavaScript Client Template Execution

Source: https://northflank.com/docs/v1/api/team/templates/run-template.md

Example request and response for triggering a template run using the JavaScript client.

```javascript
await apiClient.run.template({
  parameters: {
    "templateId": "example-template"
  }
});
```

```json
{
  "data": {
    "name": "Example Template",
    "description": "This is a sample template.",
    "apiVersion": "v1.2",
    "options": {
      "autorun": false,
      "concurrencyPolicy": "allow"
    },
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile"
    },
    "spec": {
      "settings": {
        "maxAttempts": 3,
        "backoff": {
          "type": "fixed",
          "delay": 60
        }
      },
      "kind": "Workflow",
      "response": {
        "status": "success",
        "retries": {
          "attempts": 1,
          "maxAttempts": 3,
          "timestamp": 1657296265
        },
        "startTime": 1657296265,
        "endTime": 1657296265
      }
    },
    "id": "3dd592f6-ce63-45ee-acf8-13dc5ec5235c",
    "templateId": "example-template",
    "status": "success",
    "concluded": true,
    "createdAt": "2021-01-01 12:00:00.000Z",
    "updatedAt": "2021-01-01 12:00:00.000Z"
  },
  "rawResponse": "...",
  "request": "...",
  "error": "..."
}
```

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

### Create Template API Request

Source: https://northflank.com/docs/v1/api/team/templates/create-template.md

Examples of how to send a POST request to create a template using different programming languages.

```javascript
const payload = {
  "name": "Example Template",
  "description": "This is a sample template.",
  "teardownSpec": {
    "spec": {
      "kind": "Workflow"
    }
  },
  "options": {
    "autorun": false,
    "concurrencyPolicy": "allow",
    "runOnCreation": true
  },
  "gitops": {
    "vcsService": "github",
    "accountLogin": "github-user",
    "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
    "branch": "main",
    "filePath": "/Dockerfile"
  }
}

const response = await fetch('https://api.northflank.com/v1/templates', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${NORTHFLANK_API_TOKEN}`
  },
  body: JSON.stringify(payload)
})

const json = await response.json()
console.log(json)
```

```python
import requests

url = "https://api.northflank.com/v1/templates"

payload = {"name":"Example Template","description":"This is a sample template.","teardownSpec":{"spec":{"kind":"Workflow"}},"options":{"autorun":false,"concurrencyPolicy":"allow","runOnCreation":true},"gitops":{"vcsService":"github","accountLogin":"github-user","repoUrl":"https://github.com/northflank-examples/remix-postgres-redis-demo","branch":"main","filePath":"/Dockerfile"}}
headers = {"Content-Type": "application/json", "Authorization": "Bearer NORTHFLANK_API_TOKEN"}

response = requests.request("POST", url, headers = headers, json = payload)

print(response.json())
```

```go
package main

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

func main() {
  url := "https://api.northflank.com/v1/templates"

  var jsonStr = []byte(`{"name":"Example Template","description":"This is a sample template.","teardownSpec":{"spec":{"kind":"Workflow"}},"options":{"autorun":false,"concurrencyPolicy":"allow","runOnCreation":true},"gitops":{"vcsService":"github","accountLogin":"github-user","repoUrl":"https://github.com/northflank-examples/remix-postgres-redis-demo","branch":"main","filePath":"/Dockerfile"}}`)
  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))
}
```

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

### API Example Response

Source: https://northflank.com/docs/v1/api/org/cloud-providers/list-provider-node-types.md

Example JSON response for the GET /v1/cloud-providers/node-types endpoint.

```json
{
  "data": {
    "providers": [
      {
        "id": "n2-standard-8",
        "name": "n2-standard-8",
        "resources": {
          "vcpu": 8,
          "memory": 32
        },
        "family": "N",
        "processorFamily": "intel",
        "workloadType": "general-purpose"
      }
    ]
  }
}
```

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

### Create a standard project

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

Examples for creating a new project with default region settings.

```javascript
const payload = {
  "name": "New Project",
  "description": "This is a new project.",
  "color": "#EF233C",
  "region": "europe-west",
  "networking": {
    "tailscale": {
      "restrictions": {
        "tagMatchCondition": "or"
      },
      "tailscaleOptions": {
        "tailnetServicesRestrictions": {
          "tagMatchCondition": "or"
        }
      }
    },
    "hostAliases": {
      "restrictions": {
        "tagMatchCondition": "or"
      }
    }
  }
}

const response = await fetch('https://api.northflank.com/v1/projects', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${NORTHFLANK_API_TOKEN}`
  },
  body: JSON.stringify(payload)
})

const json = await response.json()
console.log(json)
```

```python
import requests

url = "https://api.northflank.com/v1/projects"

payload = {"name":"New Project","description":"This is a new project.","color":"#EF233C","region":"europe-west","networking":{"tailscale":{"restrictions":{"tagMatchCondition":"or"},"tailscaleOptions":{"tailnetServicesRestrictions":{"tagMatchCondition":"or"}}},"hostAliases":{"restrictions":{"tagMatchCondition":"or"}}}}
headers = {"Content-Type": "application/json", "Authorization": "Bearer NORTHFLANK_API_TOKEN"}

response = requests.request("POST", url, headers = headers, json = payload)

print(response.json())
```

```go
package main

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

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

  var jsonStr = []byte(`{"name":"New Project","description":"This is a new project.","color":"#EF233C","region":"europe-west","networking":{"tailscale":{"restrictions":{"tagMatchCondition":"or"},"tailscaleOptions":{"tailnetServicesRestrictions":{"tagMatchCondition":"or"}}},"hostAliases":{"restrictions":{"tagMatchCondition":"or"}}}}`)
  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))
}
```

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

### Get template response

Source: https://northflank.com/docs/v1/api/team/templates/get-template.md

The response object containing template metadata, specification, and GitOps configuration.

```json
{
  "data": {
    "name": "Example Template",
    "description": "This is a sample template.",
    "apiVersion": "v1.2",
    "spec": {
      "kind": "Workflow",
      "spec": {
        "type": "sequential",
        "context": {
          "projectId": "example-project"
        }
      }
    },
    "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"
  },
  "rawResponse": "...",
  "request": "...",
  "error": "..."
}
```

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

### Start a build with current settings

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

JSON payload for initiating a build using existing project settings.

```json
{
  "sha": "262ed9817b3cad5142fbceabe0c9e371e390d616"
}
```

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

### Get Preview Template Response Example

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

Example JSON response returned by the preview template endpoint.

```json
{
  "data": {
    "apiVersion": "v1.2",
    "triggers": [
      {
        "vcsService": "github",
        "accountLogin": "github-user",
        "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
        "pathIgnoreRules": [
          "README.md"
        ],
        "ciIgnoreFlags": [
          "[skip ci]"
        ]
      }
    ],
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile"
    },
    "spec": {
      "kind": "Workflow"
    },
    "id": "example-template",
    "paused": false
  }
}
```

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

### northflank get template-run

Source: https://northflank.com/docs/v1/api/team/templates/get-template-run.md

Retrieves the details of a specific template run.

```APIDOC
## northflank get template-run

### Description
Retrieves the details of a specific template run, including its status, configuration, and execution history.

### Parameters
- **--templateId** (string) - Required - ID of the template.
- **--templateRunId** (string) - Required - ID of the template run.
- **--verbose** (flag) - Optional - Enables verbose output.
- **--quiet** (flag) - Optional - Suppresses console output.
- **-o, --output** (string) - Optional - Specifies the output formatting.

### Response Example
{
  "name": "Example Template",
  "description": "This is a sample template.",
  "apiVersion": "v1.2",
  "options": {
    "autorun": false,
    "concurrencyPolicy": "allow"
  },
  "gitops": {
    "vcsService": "github",
    "accountLogin": "github-user",
    "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
    "branch": "main",
    "filePath": "/Dockerfile"
  },
  "spec": {
    "settings": {
      "maxAttempts": 3,
      "backoff": {
        "type": "fixed",
        "delay": 60
      }
    },
    "kind": "Workflow",
    "response": {
      "status": "success",
      "retries": {
        "attempts": 1,
        "maxAttempts": 3,
        "timestamp": 1657296265
      },
      "startTime": 1657296265,
      "endTime": 1657296265
    }
  },
  "id": "3dd592f6-ce63-45ee-acf8-13dc5ec5235c",
  "templateId": "example-template",
  "status": "success",
  "concluded": true,
  "createdAt": "2021-01-01 12:00:00.000Z",
  "updatedAt": "2021-01-01 12:00:00.000Z"
}
```

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

### northflank get template

Source: https://northflank.com/docs/v1/api/team/templates/get-template.md

Retrieves details about a specific template using the Northflank CLI.

```APIDOC
## northflank get template

### Description
Retrieves the details of a specific template by its ID.

### Command
`northflank get template`

### Options
- **--templateId** (string) - Required - The ID of the template to retrieve.
- **--per_page** (integer) - Optional - The number of results to display per request (max 100).
- **--page** (integer) - Optional - The page number to access.
- **--cursor** (string) - Optional - The cursor returned from the previous page of results.
- **--verbose** (flag) - Optional - Enable verbose output.
- **--quiet** (flag) - Optional - Suppress console output.
- **-o, --output** (string) - Optional - Specify the output format.

### Response Example
{
  "name": "Example Template",
  "description": "This is a sample template.",
  "apiVersion": "v1.2",
  "spec": {
    "kind": "Workflow",
    "spec": {
      "type": "sequential",
      "context": {
        "projectId": "example-project"
      }
    }
  },
  "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"
}
```

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

### API Example Response

Source: https://northflank.com/docs/v1/api/project/addons/list-addon-containers.md

Example JSON response for a successful GET request to list addon containers.

```json
{
  "data": {
    "containers": [
      {
        "name": "example-service-78b4d4459d-sbtn8",
        "createdAt": 1611241087,
        "status": "TASK_RUNNING",
        "updatedAt": 1611241087
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}
```

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

### Job deployment response examples

Source: https://northflank.com/docs/v1/api/project/jobs/get-job-deployment.md

Example JSON responses showing different deployment configurations, such as internal repository builds or external image paths.

```json
{
  "data": {
    "region": "europe-west",
    "instances": 1,
    "docker": {
      "configType": "default",
      "customCommand": "nginx -g"
    },
    "buildpack": {
      "configType": "default"
    },
    "storage": {
      "ephemeralStorage": {
        "storageSize": 1024
      }
    },
    "internal": {
      "appId": "/example-user/default-project/example-service",
      "nfObjectId": "example-service",
      "repository": "https://github.com/northflank/gatsby-with-northflank",
      "branch": "master",
      "buildId": "incredible-land-3266",
      "buildSHA": "latest",
      "deployedSHA": "262ed9817b3cad5142fbceabe0c9e371e390d616",
      "nfObjectType": "service"
    }
  },
  "rawResponse": "...",
  "request": "...",
  "error": "..."
}
```

```json
{
  "data": {
    "region": "europe-west",
    "instances": 1,
    "docker": {
      "configType": "default",
      "customCommand": "nginx -g"
    },
    "buildpack": {
      "configType": "default"
    },
    "storage": {
      "ephemeralStorage": {
        "storageSize": 1024
      }
    },
    "external": {
      "imagePath": "nginx:latest",
      "registryProvider": "dockerhub",
      "privateImage": false
    }
  },
  "rawResponse": "...",
  "request": "...",
  "error": "..."
}
```

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

### API Example Response

Source: https://northflank.com/docs/v1/api/team/templates/list-templates.md

The JSON structure returned by the GET /v1/templates or GET /v1/teams/{teamId}/templates endpoints.

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

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

### Addon Import Configuration Examples

Source: https://northflank.com/docs/v1/api/project/addons/import-addon-backup.md

JSON configuration formats for importing via connection string or external archive.

```json
{
  "name": "Example Backup",
  "connectionString": "mongodb://mongodb0.example.com:27017",
  "compressionType": "gz"
}
```

```json
{
  "name": "Example Backup",
  "importUrl": "https://example.com/backup.db.gz"
}
```

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

### GET /v1/templates/{templateId}

Source: https://northflank.com/docs/v1/api/team/templates/get-template.md

Retrieves the details of a specific template by its ID.

```APIDOC
## GET /v1/templates/{templateId}

### Description
Retrieves the details of a specific template by its ID.

### Method
GET

### Endpoint
/v1/templates/{templateId}

### Parameters
#### Path Parameters
- **templateId** (string) - Required - The unique identifier for the template.

### Response
#### Success Response (200)
- **id** (string) - Identifier for the template.
- **gitops** (object) - GitOps configuration details.
- **concurrencyPolicy** (string) - Concurrency behavior of the template.
- **options** (object) - Template options including autorun status.
- **createdAt** (string) - Time of creation.
- **updatedAt** (string) - Time of update.
```

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

### API Example Response

Source: https://northflank.com/docs/v1/api/team/domains/list-domains.md

The JSON structure returned by the GET /v1/domains or GET /v1/teams/{teamId}/domains endpoints.

```json
{
  "data": {
    "domains": [
      {
        "name": "example.com",
        "status": "verified",
        "hostname": "nfverify1608026055",
        "token": "e596987b52855a4a773ef580ce2985d7746b37ce8b2a443d20fa27b913d8f57"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}
```

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

### Create Volume Request Examples

Source: https://northflank.com/docs/v1/api/project/volumes/create-volume.md

Examples showing how to create a volume using cURL and JavaScript fetch.

```curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Volume","mounts":[{"volumeMountPath":"","containerMountPath":"/container"}],"spec":{"storageClassName":"ssd","storageSize":6144},"source":{"sourceId":"example-volume/example-backup"},"attachedObjects":[{"id":"example-service","type":"service"}]}' \
  https://api.northflank.com/v1/projects/{projectId}/volumes
```

```javascript
const payload = {
  "name": "Example Volume",
  "mounts": [
    {
      "volumeMountPath": "",
      "containerMountPath": "/container"
    }
  ],
  "spec": {
    "storageClassName": "ssd",
    "storageSize": 6144
  },
  "source": {
    "sourceId": "example-volume/example-backup"
  },
  "attachedObjects": [
    {
      "id": "example-service",
      "type": "service"
    }
  ]
}

const response = await fetch('https://api.northflank.com/v1/projects/{projectId}/volumes', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${NORTHFLANK_API_TOKEN}`
  },
  body: JSON.stringify(payload)
})

const json = await response.json()
console.log(json)
```

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

### Template Run JSON Structure

Source: https://northflank.com/docs/v1/api/team/templates/abort-template-run.md

Example JSON objects representing the structure of a template run and the response received after an abort operation.

```json
{
  "data": {
    "name": "Example Template",
    "description": "This is a sample template.",
    "apiVersion": "v1.2",
    "options": {
      "autorun": false,
      "concurrencyPolicy": "allow"
    },
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile"
    },
    "spec": {
      "settings": {
        "maxAttempts": 3,
        "backoff": {
          "type": "fixed",
          "delay": 60
        }
      },
      "kind": "Workflow",
      "response": {
        "status": "success",
        "retries": {
          "attempts": 1,
          "maxAttempts": 3,
          "timestamp": 1657296265
        },
        "startTime": 1657296265,
        "endTime": 1657296265
      }
    },
    "id": "3dd592f6-ce63-45ee-acf8-13dc5ec5235c",
    "templateId": "example-template",
    "status": "success",
    "concluded": true,
    "createdAt": "2021-01-01 12:00:00.000Z",
    "updatedAt": "2021-01-01 12:00:00.000Z"
  }
}
```

```json
{
  "name": "Example Template",
  "description": "This is a sample template.",
  "apiVersion": "v1.2",
  "options": {
    "autorun": false,
    "concurrencyPolicy": "allow"
  },
  "gitops": {
    "vcsService": "github",
    "accountLogin": "github-user",
    "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
    "branch": "main",
    "filePath": "/Dockerfile"
  },
  "spec": {
    "settings": {
      "maxAttempts": 3,
      "backoff": {
        "type": "fixed",
        "delay": 60
      }
    },
    "kind": "Workflow",
    "response": {
      "status": "success",
      "retries": {
        "attempts": 1,
        "maxAttempts": 3,
        "timestamp": 1657296265
      },
      "startTime": 1657296265,
      "endTime": 1657296265
    }
  },
  "id": "3dd592f6-ce63-45ee-acf8-13dc5ec5235c",
  "templateId": "example-template",
  "status": "success",
  "concluded": true,
  "createdAt": "2021-01-01 12:00:00.000Z",
  "updatedAt": "2021-01-01 12:00:00.000Z"
}
```
Tokens:
Raw