API Reference

Blackwalnut provides a REST API for managing all aspects of your licensing system. The API follows REST conventions and returns JSON responses.

Base URL

https://your-blackwalnut-instance.com/api/v1

Most API endpoints require authentication via Bearer token. You can create API keys from the settings page in your Blackwalnut dashboard.

Full read/write access. Use for server-side integrations. Never expose in client code.

Read-only access. Safe for client-side use where needed.

Authentication header

Authorization: Bearer sk_live_your_api_key

All responses follow a consistent JSON structure:

Single resource

{
  "data": {
    "id": "app_abc123",
    "name": "My App",
    ...
  }
}

Collection with pagination

{
  "data": [...],
  "meta": {
    "total": 150,
    "page": 1,
    "per_page": 20
  }
}

Error format

{
  "error": {
    "code": "validation_error",
    "message": "Email is invalid",
    "details": {
      "email": ["is invalid"]
    }
  }
}

Create, read, update, delete applications. Manage RSA keys.

Manage customers, filter, paginate, and link to external systems.

Issue, revoke, extend, and manage license tokens.

Public endpoints for license verification. No auth required.

The full API specification is available in OpenAPI 3.0 format. Use it to generate client libraries or explore with Swagger UI.

Public endpoints (verification) are rate limited to prevent abuse:

Authenticated endpoints have higher limits based on your plan.