Quick Start¶
Get from zero to your first authenticated API call in under five minutes.
Prerequisites¶
- An email address you can verify
curlinstalled (or any HTTP client)
Step 1 — Create an account¶
curl -X POST https://api.bnerd.cloud/create-account \
-H "Content-Type: application/json" \
-d '{
"login": "you@example.com",
"name": "Your Name",
"password": "a-strong-password",
"password-confirm": "a-strong-password",
"organization_name": "My Org"
}'
You will receive a verification email. Click the link to activate your account before proceeding.
Step 2 — Log in and obtain a JWT¶
curl -si -X POST https://api.bnerd.cloud/login \
-H "Content-Type: application/json" \
-d '{"login": "you@example.com", "password": "a-strong-password"}' \
| grep -i '^authorization:'
The response header contains your JWT:
Save it:
Step 3 — Verify the token works¶
You should see your account details returned as JSON.
Step 4 — Find your organization¶
Note the id of your organization — you'll need it when creating projects and managing resources.
Step 5 — Create a project¶
Projects group resources (servers, DNS zones, Kubernetes clusters, object storage users) within an organization.
ORG_ID="<your-org-id>"
curl -X POST https://api.bnerd.cloud/organizations/$ORG_ID/projects \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"project": {"name": "my-first-project"}}'
Step 6 — Generate a static API token (optional but recommended)¶
JWTs expire. For scripts, Terraform, and CI/CD, use a long-lived static token scoped to your organization. Create one in the Dashboard under Settings → API Tokens, then use it the same way:
Next steps¶
| I want to… | Go to |
|---|---|
| Understand the auth options in depth | Authentication |
| Learn about organizations and roles | Concepts |
| Provision object storage | Provision S3 Storage |
| Manage DNS | Manage DNS |
| Use Terraform | Infrastructure as Code |
| Browse all API endpoints | API Reference |