Getting StartedIntroduction
Getting Started
Introduction
Build reliable integrations with the fictional Northstar platform.
Northstar is a fictional developer platform used to demonstrate how polished product documentation can look in Knowybase. Its API lets teams manage projects, deploy releases, and react to lifecycle events.
What you can build
| Capability | Example | New column |
|---|---|---|
| Project management | Provision and configure projects programmatically | |
| Automated delivery | Trigger deployments from CI/CD pipelines | |
| Observability | Monitor release status and retrieve deployment logs | |
| Event automation | React to signed webhook events |
API fundamentals
The API is REST-based, accepts JSON, and uses predictable resource-oriented URLs. All requests are made over HTTPS to:
textsnippet
https://api.northstar.example/v1Successful responses use standard HTTP status codes. Errors include a stable machine-readable code, a human-readable message, and a request identifier for support.
Before you begin
You will need a Northstar workspace and an API token. Start with the Quickstart to make your first request, then review Authentication before using the API in production.
Northstar is sample content. Its URLs, credentials, and resources are intentionally fictional.