Quickstart

Make your first Northstar API request in under five minutes.

This guide creates a project and retrieves it from the Northstar API.

1. Create an API token

Open your workspace settings, choose API tokens, and create a token with the projects:write scope. Copy it immediately; Northstar only displays it once.

Store the token in your shell:

bash

export NORTHSTAR_TOKEN="ns_test_replace_me"

2. Create a project

bash

curl --request POST \
  --url https://api.northstar.example/v1/projects \
  --header "Authorization: Bearer $NORTHSTAR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"name":"Demo Store","region":"eu-west"}'

The response contains the new project identifier:

json

{
  "id": "prj_01J8YQ2N7F",
  "name": "Demo Store",
  "region": "eu-west",
  "status": "ready"
}

3. Retrieve the project

bash

curl https://api.northstar.example/v1/projects/prj_01J8YQ2N7F \
  --header "Authorization: Bearer $NORTHSTAR_TOKEN"

You are ready to configure an SDK, create deployments, and subscribe to webhooks.

Introduction

Installation