Organization API: Customer Portal: Software

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Every addon in the folders the server loads from, tracked or hand-uploaded

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Every addon in the folders the server loads from, tracked or hand-uploaded

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/addons

Every addon in the folders the server loads from, tracked or hand-uploaded.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes
`kind`	query	string or null	no

Responses

Section titled Drop a tracking record whose files are gone, without touching the disk

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Drop a tracking record whose files are gone, without touching the disk

DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/addons/records/{record_uuid}

Drop a tracking record whose files are gone, without touching the disk.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`record_uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Delete one addon from disk, through the tracked uninstall when it has a record

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete one addon from disk, through the tracked uninstall when it has a record

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/addons/remove

Delete one addon from disk, through the tracked uninstall when it has a record.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Switch one addon file on or off (Foo.jar <- Foo.jar.disabled)

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Switch one addon file on or off (Foo.jar <- Foo.jar.disabled)

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/addons/toggle

Switch one addon file on or off (Foo.jar <-> Foo.jar.disabled).

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Turn Bedrock crossplay on or off for a Java server

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Turn Bedrock crossplay on or off for a Java server

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock

Turn Bedrock crossplay on or off for a Java server.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Behavior and resource packs on disk, which are active in the world, and importable uploads

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Behavior and resource packs on disk, which are active in the world, and importable uploads

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs

Behavior and resource packs on disk, which are active in the world, and importable uploads.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Empty the world's activation lists so it boots on vanilla content; folders stay

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Empty the world's activation lists so it boots on vanilla content; folders stay

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs/disable-all

Empty the world's activation lists so it boots on vanilla content; folders stay.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Queue an import of an uploaded .mcaddon / .mcpack / .zip already on the server

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Queue an import of an uploaded .mcaddon / .mcpack / .zip already on the server

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs/import

Queue an import of an uploaded .mcaddon / .mcpack / .zip already on the server.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Add a pack to, or drop it from, the world's activation list

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Add a pack to, or drop it from, the world's activation list

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs/{pack_uuid}/active

Add a pack to, or drop it from, the world's activation list.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`pack_uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Deactivate a pack, delete its folder, and drop its tracking row

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Deactivate a pack, delete its folder, and drop its tracking row

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs/{pack_uuid}/remove

Deactivate a pack, delete its folder, and drop its tracking row.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`pack_uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Texturepack-required: players must accept the resource packs to join

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Texturepack-required: players must accept the resource packs to join

PUT /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/texturepack-required

texturepack-required: players must accept the resource packs to join.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Software catalog

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Software catalog

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/catalog

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Software catalog versions

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Software catalog versions

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/catalog/{key}/versions

Parameters

Name	In	Type	Required	Description
`uuid`	path	string	yes
`key`	path	string	yes
`org_slug`	path	string	yes
`limit`	query	integer	no	Default: `200`.
`include_unsupported`	query	boolean	no	Default: `False`.

Responses

Section titled Publisher builds of one game version: the loader versions for Fabric/Forge

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Publisher builds of one game version: the loader versions for Fabric/Forge

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/catalog/{key}/versions/{version}/builds

Publisher builds of one game version: the loader versions for Fabric/Forge.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`key`	path	string	yes
`version`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Change server software

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Change server software

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/change

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Software context

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Software context

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/context

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled What a version requires, named, with what is already installed marked

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

What a version requires, named, with what is already installed marked

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/dependencies/{source_uuid}/{identifier}

What a version requires, named, with what is already installed marked.

Parameters

Name	In	Type	Required	Description
`uuid`	path	string	yes
`source_uuid`	path	string	yes
`identifier`	path	string	yes
`org_slug`	path	string	yes
`version`	query	string	no	Default: `latest`.
`kind`	query	string or null	no

Responses

Section titled Install software

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Install software

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/install

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: SoftwareInstallBody or object.

Responses

Section titled List software installs

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List software installs

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/installs

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes
`status`	query	string or null	no

Responses

Section titled Get software install

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Get software install

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/installs/{install_uuid}

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`install_uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Cancel software install

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Cancel software install

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/installs/{install_uuid}/cancel

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`install_uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Retry software install

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Retry software install

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/installs/{install_uuid}/retry

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`install_uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled The heap slider and the allowlisted startup flags, as the panel shows them

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

The heap slider and the allowlisted startup flags, as the panel shows them

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/jvm

The heap slider and the allowlisted startup flags, as the panel shows them.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Move the heap, pick startup flags from the catalog, or reset both

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Move the heap, pick startup flags from the catalog, or reset both

PATCH /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/jvm

Move the heap, pick startup flags from the catalog, or reset both. Applies on restart.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled The server resource pack as server.properties declares it

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

The server resource pack as server.properties declares it

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/resource-pack

The server resource pack as server.properties declares it.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Point players at a pack, from a URL or a marketplace resource pack version

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Point players at a pack, from a URL or a marketplace resource pack version

PUT /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/resource-pack

Point players at a pack, from a URL or a marketplace resource pack version.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Stop offering a server resource pack

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Stop offering a server resource pack

DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/resource-pack

Stop offering a server resource pack.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Arm a one-shot --safeMode start (vanilla datapack only), optionally starting now

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Arm a one-shot --safeMode start (vanilla datapack only), optionally starting now

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/safe-mode

Arm a one-shot --safeMode start (vanilla datapack only), optionally starting now.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Type: Body.

Responses

Section titled Search software

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Search software

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/search

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`query`	string	no
`source`	string or null	no
`source_uuid`	string or null	no
`page`	integer	no
`limit`	integer	no
`kind`	string or null	no
`sort`	string or null	no
`loaders`	array of string or null	no
`game_versions`	array of string or null	no

Responses

Section titled Software sources

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Software sources

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/sources

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes
`kind`	query	string or null	no

Responses

Section titled Newer compatible builds for the addons the marketplace installed

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Newer compatible builds for the addons the marketplace installed

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/updates

Newer compatible builds for the addons the marketplace installed.

Parameters

Name	In	Type	Required	Description
`uuid`	path	string	yes
`org_slug`	path	string	yes
`kind`	query	string or null	no
`include_current`	query	boolean	no	Default: `False`.

Responses

Section titled Software versions

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Software versions

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/versions/{source_uuid}/{identifier}

Parameters

Name	In	Type	Required	Description
`uuid`	path	string	yes
`source_uuid`	path	string	yes
`identifier`	path	string	yes
`org_slug`	path	string	yes
`page`	query	integer	no	Default: `1`.
`limit`	query	integer	no	Default: `50`.
`loaders`	query	string or null	no
`game_versions`	query	string or null	no
`kind`	query	string or null	no
`include_incompatible`	query	boolean	no	List builds for other loaders / game versions too, flagged Default: `False`.

Responses

Section titled Uninstall software

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Uninstall software

DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/{record_uuid}

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`record_uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Queue an in-place update: the old file is removed, the new build installed

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Queue an in-place update: the old file is removed, the new build installed

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/{record_uuid}/update

Queue an in-place update: the old file is removed, the new build installed.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`record_uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json

Type: object or null.

Responses