Skip to main content
GET
/
api
/
v3
/
builds
/
{build_id}
Get build details
curl --request GET \
  --url https://playflow.dev/api/api/v3/builds/{build_id} \
  --header 'api-key: <api-key>'
{
  "build_id": "<string>",
  "name": "<string>",
  "version": 123,
  "status": "uploading",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "build_type": "zip",
  "executable_path": "<string>",
  "image_url": "<string>"
}

Authorizations

​
api-key
string
header
required

Path Parameters

​
build_id
string
required

Unique build ID (UUID).

Response

Full build details.

Details of a game server build artifact.

​
build_id
string
required

Unique identifier for this build (UUID).

​
name
string
required

Build name (e.g., "default", "beta"). Multiple versions can share the same name.

​
version
number
required

Auto-incrementing version number within this build name. The first build named "default" is version 1, the next is version 2, etc.

​
status
enum<string>
required

Build lifecycle status. "uploading": ZIP uploaded, awaiting processing. "processing": GitHub Actions is building the Docker image. "ready": build is deployable. "failed": processing failed (check build logs). "deleted": soft-deleted, no longer usable.

Available options:
uploading,
processing,
ready,
failed,
deleted
​
created_at
string<date-time>
required

ISO 8601 timestamp when the build was created.

​
updated_at
string<date-time> | null
required

ISO 8601 timestamp of the last status update. Null if never updated after creation.

​
build_type
enum<string>
default:zip

How this build was created. "zip": uploaded as a ZIP archive. "docker_image": created from an existing Docker image URL.

Available options:
zip,
docker_image
​
executable_path
string | null

Path to the game executable inside the build. Defaults to "Server.x86_64" if not specified during upload.

​
image_url
string | null

Source Docker image URL (only for docker_image build type). Null for ZIP builds.