Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Greens-Organization/pz-packs/llms.txt

Use this file to discover all available pages before exploring further.

List Public Modpacks

List all public modpacks with pagination, search, and sorting capabilities. No authentication required.

Query Parameters

page
number
default:"1"
Page number for pagination (must be positive integer)
limit
number
default:"10"
Number of items per page (max 100)
Search term to filter modpacks by name or description
sortBy
string
default:"createdAt"
Field to sort by: createdAt, updatedAt, or name
sortOrder
string
default:"desc"
Sort order: asc or desc

Response

data
array
pagination
object
page
number
Current page number
limit
number
Items per page
total
number
Total number of items
curl -X GET "https://api.pzpacks.com/modpacks/public?page=1&limit=10&search=zombie&sortBy=name&sortOrder=asc"
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Zombie Survival Pack",
      "description": "Essential mods for zombie survival",
      "avatarUrl": "https://example.com/avatar.jpg",
      "steamUrl": "https://steamcommunity.com/sharedfiles/filedetails/?id=123456",
      "owner": "user-uuid-here",
      "isPublic": true,
      "isVerified": false,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-16T14:20:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 45
  }
}

Get Public Modpack

Get details of a public modpack by ID. No authentication required.

Path Parameters

id
string
required
Modpack UUID

Response

id
string
Modpack UUID
name
string
Modpack name
description
string
Modpack description
avatarUrl
string
Avatar image URL
owner
string
Owner user ID
isPublic
boolean
Public visibility status
members
array
List of modpack members with permissions
curl -X GET "https://api.pzpacks.com/modpacks/public/123e4567-e89b-12d3-a456-426614174000"
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Zombie Survival Pack",
  "description": "Essential mods for zombie survival",
  "avatarUrl": "https://example.com/avatar.jpg",
  "owner": "user-uuid-here",
  "isPublic": true,
  "isVerified": false,
  "members": [],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-16T14:20:00Z"
}

List My Modpacks

List modpacks owned by or shared with the authenticated user.

Query Parameters

page
number
default:"1"
Page number for pagination
limit
number
default:"10"
Number of items per page (max 100)
search
string
Search term to filter modpacks
sortBy
string
default:"createdAt"
Field to sort by: createdAt, updatedAt, or name
sortOrder
string
default:"desc"
Sort order: asc or desc
curl -X GET "https://api.pzpacks.com/modpacks/my" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Create Modpack

Create a new modpack. The authenticated user becomes the owner.

Body Parameters

name
string
required
Modpack name (3-50 characters)
description
string
Modpack description (max 1024 characters)
avatarUrl
string
Avatar image URL (must be valid URL)
isPublic
boolean
default:"false"
Whether the modpack is publicly visible
steamWorkshopUrl
string
Steam Workshop collection URL (must be from steamcommunity.com)

Response

id
string
Created modpack UUID
name
string
Modpack name
owner
string
Owner user ID
curl -X POST "https://api.pzpacks.com/modpacks" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Survival Pack",
    "description": "Custom survival mods collection",
    "isPublic": false
  }'
{
  "id": "987fcdeb-51a2-43c1-9876-543210fedcba",
  "name": "My Survival Pack",
  "description": "Custom survival mods collection",
  "owner": "user-uuid-here",
  "isPublic": false,
  "isVerified": false,
  "isActive": true,
  "createdAt": "2024-01-17T09:15:00Z",
  "updatedAt": "2024-01-17T09:15:00Z"
}

Get Modpack

Get modpack details by ID. Access is granted to the owner, members, or if the modpack is public.

Path Parameters

id
string
required
Modpack UUID
curl -X GET "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Zombie Survival Pack",
  "description": "Essential mods for zombie survival",
  "avatarUrl": "https://example.com/avatar.jpg",
  "owner": "user-uuid-here",
  "isPublic": false,
  "isVerified": false,
  "members": [
    {
      "userId": "member-uuid",
      "permission": ["read", "add-mod"],
      "isActive": true
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-16T14:20:00Z"
}

Update Modpack

Update modpack details. Only the owner can update the modpack.

Path Parameters

id
string
required
Modpack UUID

Body Parameters

name
string
Modpack name (3-50 characters)
description
string
Modpack description (max 1024 characters)
avatarUrl
string
Avatar image URL
isPublic
boolean
Public visibility status
steamWorkshopUrl
string
Steam Workshop URL (must be from steamcommunity.com)
metadata
object
curl -X PATCH "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Survival Pack",
    "isPublic": true
  }'

Archive Modpack

Archive (soft delete) a modpack. Only the owner can archive the modpack.

Path Parameters

id
string
required
Modpack UUID
curl -X DELETE "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Modpack archived successfully"
}

Import from Steam

Import mods from a Steam Workshop collection to the modpack. This is an asynchronous operation.

Path Parameters

id
string
required
Modpack UUID

Body Parameters

steamUrl
string
required
Steam Workshop collection URL (must be from steamcommunity.com)
curl -X POST "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000/import" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "steamUrl": "https://steamcommunity.com/sharedfiles/filedetails/?id=2898758886"
  }'
{
  "message": "Import job started",
  "status": "pending"
}

Get Import Status

Get the status of a modpack import job.

Path Parameters

id
string
required
Modpack UUID
curl -X GET "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000/import/status" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "status": "completed",
  "modsImported": 25,
  "modsFailed": 0
}

Request Server File

Request generation of a server configuration file for the modpack.

Path Parameters

id
string
required
Modpack UUID

Body Parameters

version
string
required
Game version: 41x or 42x
curl -X POST "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000/server-file" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "version": "42x"
  }'
{
  "exportId": "export-uuid-here",
  "status": "pending"
}

Download Server File

Download a generated server configuration file.

Path Parameters

exportId
string
required
Export UUID from server file request
curl -X GET "https://api.pzpacks.com/modpacks/export/export-uuid-here/download" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -o servertest.ini

Get Export Configuration

Get the export configuration for a modpack, including mod order and mod-specific settings.

Path Parameters

id
string
required
Modpack UUID
curl -X GET "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000/export-configuration" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "modsOrder": ["mod-uuid-1", "mod-uuid-2", "mod-uuid-3"],
  "modConfig": {
    "mod-uuid-1": {
      "selectedSteamModIds": ["2898758886"]
    }
  }
}

Save Export Configuration

Save export configuration for a modpack, including mod load order and per-mod settings.

Path Parameters

id
string
required
Modpack UUID

Body Parameters

modsOrder
array
Array of mod IDs in desired load order
modConfig
object
Configuration object with mod IDs as keys, each containing selectedSteamModIds array
curl -X PUT "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000/export-configuration" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "modsOrder": ["mod-uuid-1", "mod-uuid-2"],
    "modConfig": {
      "mod-uuid-1": {
        "selectedSteamModIds": ["2898758886"]
      }
    }
  }'

List Mods in Modpack

List all mods in a modpack with pagination and filtering.

Path Parameters

id
string
required
Modpack UUID

Query Parameters

page
string
default:"1"
Page number
limit
string
default:"10"
Items per page
search
string
Search term
sortBy
string
default:"createdAt"
Sort field: createdAt, updatedAt, or name
sortOrder
string
default:"asc"
Sort order: asc or desc
tags
string | array
Filter by tags (comma-separated string or array)
curl -X GET "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000/mods?page=1&limit=20"
{
  "data": [
    {
      "id": "mod-uuid-1",
      "name": "Hydrocraft",
      "workshopId": "2898758886",
      "steamModId": ["Hydrocraft"],
      "description": "Massive crafting expansion",
      "avatarUrl": "https://example.com/mod-avatar.jpg",
      "tags": ["crafting", "survival"],
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45
  }
}

Add Mod to Modpack

Add a mod to the modpack by Steam Workshop URL or mod ID. Owner and members can add mods.

Path Parameters

id
string
required
Modpack UUID

Body Parameters

modAtribute
string
required
Steam Workshop URL or mod identifier (min 1 character, or valid URL)
curl -X POST "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000/mods" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "modAtribute": "https://steamcommunity.com/sharedfiles/filedetails/?id=2898758886"
  }'
{
  "id": "modpack-mod-uuid",
  "modpackId": "123e4567-e89b-12d3-a456-426614174000",
  "modId": "mod-uuid-1",
  "isActive": true,
  "createdAt": "2024-01-17T09:30:00Z"
}

Remove Mod from Modpack

Remove a mod from the modpack. Owner and members can remove mods.

Path Parameters

id
string
required
Modpack UUID
modId
string
required
Mod UUID
curl -X DELETE "https://api.pzpacks.com/modpacks/123e4567-e89b-12d3-a456-426614174000/mods/mod-uuid-1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Mod removed from modpack successfully"
}

Build docs developers (and LLMs) love