Nexus Quick Start

Get started with Solenoid Nexus in 5 minutes. Create a project, understand resource isolation, and see aggregated overview.

Prerequisites

  • Solenoid API key (sign up here)
  • curl or equivalent HTTP client

Step 1: Create a project

Projects organize resources across all Solenoid products. Your default project was created automatically on signup.

curl -X POST "https://api.solenoid.systems/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production",
    "description": "Live environment resources"
  }'

Response:

{
  "id": "proj_abc123def456...",
  "name": "Production",
  "slug": "production",
  "description": "Live environment resources",
  "created_at": "2026-02-10T12:00:00Z",
  "updated_at": "2026-02-10T12:00:00Z"
}

Step 2: List your projects

See all projects in your account:

curl "https://api.solenoid.systems/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response includes default project + newly created project:

{
  "projects": [
    {
      "id": "proj_default...",
      "name": "Default",
      "slug": "default",
      "description": null,
      "created_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "proj_abc123...",
      "name": "Production",
      "slug": "production",
      "description": "Live environment resources",
      "created_at": "2026-02-10T12:00:00Z"
    }
  ]
}

Step 3: Create resources in your project

Use your API key to create resources. They’re automatically scoped to the project associated with your key:

# Create a feature flag (scoped to project from API key)
curl -X POST "https://api.solenoid.systems/v1/gate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "new_checkout_flow",
    "enabled": true,
    "description": "Redesigned checkout experience"
  }'

Response includes project_id:

{
  "key": "new_checkout_flow",
  "enabled": true,
  "description": "Redesigned checkout experience",
  "project_id": "proj_abc123...",
  "created_at": "2026-02-10T12:05:00Z"
}

Step 4: Get project overview

See all resources across products:

curl "https://api.solenoid.systems/v1/projects/proj_abc123.../overview" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "project_id": "proj_abc123...",
  "project_name": "Production",
  "resources": {
    "flags": 1,
    "monitors": 0,
    "relays": 0,
    "buckets": 0,
    "keys": 0,
    "locks": 0,
    "chains": 0,
    "meters": 0
  },
  "usage": {
    "meter_balance": 10000,
    "last_activity": "2026-02-10T12:05:00Z"
  }
}

Step 5: Switch projects

To work with a different project, use an API key scoped to that project. Create keys via the Key API:

curl -X POST "https://api.solenoid.systems/v1/keys" \
  -H "Authorization: Bearer YOUR_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production API Key",
    "prefix": "prod",
    "project_id": "proj_abc123..."
  }'

Now use the new key for all production project operations — no query parameters needed.

Best practices

  1. One project per environment — production, staging, development
  2. Descriptive names — “Customer Acme Inc” not “project-17”
  3. Don’t delete default — create other projects first, then migrate
  4. Use project overview — cached aggregation, safe for dashboards

Next steps