API Reference

Base URL

All API requests are made to:

# Hosted version
https://releasehub.dev

# Self-hosted
https://your-releasehub-instance.com

Authentication

Login (JWT)

Authenticate to receive a JWT token for admin API access:

Request Body

{
  "email": "admin@releasehub.local",
  "password": "your-password"
}

Response

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOi...",
  "token_type": "bearer",
  "expires_in": 3600,
  "user": {
    "id": "01HQXYZ...",
    "email": "user@example.com",
    "name": "John Doe",
    "role": "admin"
  }
}

API Keys

For upload and public API access, use project API keys instead of JWT:

# Include in request headers
Authorization: Bearer {api_key}

Public API

Version Check

Check if an update is available for a project:

{projectKey} can be either the project slug (e.g., my-app) or bundle ID (e.g., com.example.myapp).

Query Parameters

Example Request

Response

{
  "hasUpdate": true,
  "latestVersion": {
    "version": "1.2.0",
    "build": 42,
    "versionString": "1.2.0+42",
    "releaseNotes": "Bug fixes and improvements",
    "minVersion": "1.0.0",
    "isRequired": false
  },
  "download": {
    "url": "/api/download/my-app/42/arm64-v8a"
  }
}

Download

Download a release file:

Returns the binary file. The UUID is provided in the version check response.

Download Latest Version

Download the latest version directly without knowing the UUID:

Optional query parameter: ?channel=beta to specify release channel.

Example

Public Projects

Upload API

ReleaseHub uses chunked uploads to handle large files and bypass PHP limits. All upload endpoints require an API key with upload permissions.

Initialize Upload

Request

// Headers
Authorization: Bearer {api_key}
Content-Type: application/json

// Body
{
  "bundle_id": "com.example.myapp",
  "filename": "app-release.apk",
  "file_size": 52428800,
  "chunk_size": 5242880,
  "version": "1.3.0",
  "build_number": 52,
  "platform": "android",
  "architecture": "arm64-v8a"
}

Use either bundle_id or project_id to identify the project. All fields except filename and file_size are optional.

Response

{
  "sessionId": "abc123-...",
  "filename": "app-release.apk",
  "fileSize": 52428800,
  "chunkSize": 5242880,
  "totalChunks": 10,
  "expiresAt": "2024-01-15T12:00:00Z"
}

Upload Chunk

// Headers
Authorization: Bearer {api_key}
Content-Type: multipart/form-data

// Form Data
session_id: {session_id}
chunk_index: 0
chunk: (binary data)

Complete Upload

Request

// Headers
Authorization: Bearer {api_key}
Content-Type: application/json

// Body
{
  "session_id": "{session_id}",
  "version": "1.3.0",
  "build_number": 52,
  "channel": "stable",
  "changelog": "## What's New\n- Bug fixes",
  "is_force_update": false,
  "is_draft": false,
  "platform": "android",
  "architecture": "arm64-v8a"
}

Response

{
  "success": true,
  "version": {
    "id": "01HQXYZ...",
    "version": "1.3.0",
    "build": 52,
    "versionString": "1.3.0+52",
    "channel": "stable",
    "isDraft": false
  },
  "file": {
    "uuid": "abc123-...",
    "filename": "app-release.apk",
    "size": 52428800,
    "platform": "android",
    "architecture": "arm64-v8a",
    "checksum": {
      "md5": "d41d8cd98f...",
      "sha256": "e3b0c44298fc..."
    },
    "downloadUrl": "/api/download/abc123-..."
  }
}

Admin API

All admin endpoints require JWT authentication. Include the token in the Authorization header:

Authorization: Bearer {jwt_token}

Projects

Versions

Release Files

Channels

Global API Keys

API keys that work across multiple projects.

Users & System

User Permissions

System & Settings

Additional Project Endpoints