Endpoints
GET /v2/mods/{mod_id}
Retrieve complete metadata for a specific mod, including author details, supported game versions, and download statistics. Returns a 200 OK with JSON payload containing mod_id, name, author, version, and asset_urls.
POST /v2/mods/{mod_id}/versions
Create a new version record for an existing mod. Requires Authorization: Bearer header. Payload must include version_tag, changelog, and compatibility_matrix. Returns 201 Created with the new version UUID.
PUT /v2/assets/{asset_id}
Upload or replace binary assets (ZIP, DLL, or PK4 files) linked to a version. Supports multipart/form-data. Max payload 256MB. Returns 200 OK with CDN distribution URL and SHA-256 checksum.
PATCH /v2/mods/{mod_id}/status
Update visibility or moderation flags for a mod. Accepted values: published, draft, review, archived. Requires maintainer or admin scope. Returns 200 OK with updated timestamp.
Examples
Standard request headers and JSON payloads for common ModVault API operations. All endpoints require a valid OAuth 2.0 bearer token scoped to mod:read or mod:write.
Fetch Mod Data
Request
GET /v2/mods/mv-7742-atmospheric-fx
Host: api.modvault.dev
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Response (200 OK)
{
"mod_id": "mv-7742-atmospheric-fx",
"name": "Atmospheric FX Overhaul",
"author": "LuminaDev",
"version": "3.1.0",
"compatibility": ["v2.4", "v2.5", "v2.6"],
"downloads": 148290,
"asset_urls": {
"primary": "https://cdn.modvault.dev/assets/7742/3.1.0.zip",
"manifest": "https://cdn.modvault.dev/manifests/7742/3.1.0.json"
}
}
Upload Version Assets
Request
POST /v2/mods/mv-8891-terrain-packer/versions
Content-Type: multipart/form-data
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
{
"version_tag": "2.0.4-beta",
"changelog": "Fixed memory leak in heightmap generation. Added support for 8K textures.",
"compatibility_matrix": ["v2.5", "v2.6"],
"file": "@terrain_packer_2.0.4.zip"
}
Response (201 Created)
{
"version_id": "ver-9921-tp-beta",
"mod_id": "mv-8891-terrain-packer",
"version_tag": "2.0.4-beta",
"status": "processing",
"checksum_sha256": "a3f8c9d2e1b4567890abcdef1234567890abcdef1234567890abcdef1234567890",
"cdn_url": "https://cdn.modvault.dev/assets/8891/2.0.4-beta.zip",
"created_at": "2024-05-12T14:32:08Z"
}