Icefish API (1.0.0)

Retrieve all supported game builds and related metadata.

Returned objects include:

• jarfile: Internal filename reference for use in servers for auto-install.
• name: Human readable game/version label.
• parent_game: The parent game or franchise this game belongs to.
• category: The category for this game.
• memory_required: Minimum memory requirement in MB.
• memory_recommended: Recommended memory in MB.
• info_url: Upstream reference or release notes link (when available).

Use this endpoint to populate game/version selectors prior to provisioning a server.

List all datacenter locations available for provisioning.

Returned objects include:

• name: Human readable label for the location.
• code: Stable short internal code, used during server provisioning.
• country_code: Two-letter country code.
• region: Higher level geographic grouping (e.g., continent or macro area).
• coordinates.latitude / coordinates.longitude: Approximate geo coordinates (not exact site).
• ping_node: Hostname you can probe to measure latency from clients.
  • ICMP: Ping towards ping_node.
  • HTTP: Perform a GET request to https://<ping_node>:3456/ping (expect Pong response).
• memory_available: Current aggregate free memory capacity (MB) for provisioning.

Use this endpoint to build region selectors and surface capacity hints.

Retrieve a paginated collection of servers you have access to.

Query parameters:

• user_id: Filter results to servers assigned to a specific end user.
• page: 1-based page index.
• pageSize: Number of items per page (upper bound enforced server-side).

Server objects (see server schema) include:

• id: Unique server identifier.
• user_id: Owning end user ID.
• jarfile: Game build / runtime identifier.
• memory: Allocated RAM in MB.
• player_slots: Configured maximum player capacity.
• world: Primary world or save name.
• suspended: Whether server is suspended.
• name: Friendly display name.
• status: Lifecycle state (started, stopped, etc.).
• ip / port: Connection target for clients.
• location_code: Deployment location code (from List Locations).

The meta block provides pagination counters enabling UI navigation.

Provision a new server instance.

Required body fields:

• user_id: End user who will own the server.
• location_code: Deployment location code (must match a value from List Locations).
• memory: Allocated RAM in MB.
• auto_start: Start automatically after creation if true.

Optional body fields:

• jarfile: Specific game jarfile to auto-install or run.
  • A jarfile listed in List Games will auto-install onto the server.
  • A jarfile not listed in List Games will be used as-is (no auto-install).
• player_slots: Player capacity limit.
• world: Initial world / save name.
• name: Friendly display name.
• suspended: Create in a suspended state if desired.

Response returns the new server id.

Fetch full configuration and runtime metadata for a single server.

Key fields (see server schema) include:

• id: Unique server identifier.
• user_id: Owning end user ID.
• jarfile: Game build / runtime identifier.
• memory: Allocated RAM in MB.
• player_slots: Configured maximum player capacity.
• world: Primary world or save name.
• suspended: Whether server is suspended.
• name: Friendly display name.
• ip / port: Connection target for clients.
• location_code: Deployment location code (from List Locations).

Apply partial updates (JSON Merge Patch) to mutable server attributes.

Updatable fields:

• user_id
• jarfile
• memory
• player_slots
• world
• suspended
• name

Notes:

• location_code and network allocation (ip/port) cannot be modified here (use a transfer workflow).
• Fields omitted from the payload are not altered.

Permanently remove a server and its associated data.

The server will be stopped automatically if it is running.

Irreversible: capture backups or exports before issuing this call if retention is required.

Return the current lifecycle status only.

Status values:

• started
• stopped
• starting
• stopping

Use for lightweight polling without fetching full server details.

Request a lifecycle action for the server.

Actions:

• start: Boot a stopped server.
• stop: Gracefully stop a running server.
• restart: Graceful stop then start.
• force_stop: Immediate termination (may risk data loss).

Action processing is asynchronous; poll Get Server Status to observe state changes.

Retrieve real-time CPU and memory utilization snapshot.

Fields:

• cpu_percent: Current CPU usage percentage.
• memory_percent: Current memory usage percentage.

Intended for dashboards & health indicators; avoid very high polling frequencies.

Retrieve recent console output lines plus the latest sequence marker for incremental polling.

Usage pattern:

1. Call without log_seq to obtain initial batch + starting log_seq.
2. Re-call with the returned log_seq to fetch only new lines.
3. Repeat for a pull-based tail experience.

Submit a single command to the server console.

Behavior:

• Command is queued asynchronously.
• Use Get Server Console to read resulting output lines.
• Order of execution is preserved per server.

Retrieve all FTP users associated with a specific server.

Returned objects include:

• id: Unique FTP user identifier.
• username: FTP base username.
• permissions: Array of permission strings assigned to the user for this server. (e.g., read, write)

Link an existing FTP user to this server with specific permissions.

Required body fields:

• ftp_user_id: ID of the FTP user to assign.
• permissions: Array of permission strings to grant (e.g., read, write).

Response confirms the assignment.

Fetch details of a specific FTP user assigned to this server.

Returned object includes:

• id: Unique FTP user identifier.
• username: FTP base username.
• permissions: Array of permission strings assigned to the user for this server. (e.g., read, write)

Modify permissions for an FTP user assigned to this server.

Updatable fields:

• permissions: Array of permission strings to set (e.g., read, write).

Notes:

• Fields omitted from the payload are not altered.

Unlink an FTP user from this server, revoking their access.

This does not delete the FTP user account itself, only the association with this server.

Retrieve connection details (hostname, port, username) for an FTP user assigned to this server.

Note: Passwords are not retrievable for security reasons. Reset the password if needed.

Retrieve all databases for a given server.

Create a new database for the server.

Change the password for a given server database.

Delete a database for a given server.

Retrieve all backup files for a server.

Start a backup for the server.

Retrieve status of current/last backup for a server.

Restore a backup file for a server.

Retrieve all FTP users associated with your reseller account.

Returned objects include:

• id: Unique FTP user identifier.
• username: FTP base username.
• servers: Array of server IDs the FTP user has access to.

Create a new FTP user associated with your reseller account.

Required body fields:

• username: Desired FTP base username (must be unique).
• password: Password for the FTP user (minimum 8 characters).

Response returns the new FTP user id, and the final base username including the per-reseller prefix.

Fetch details for a specific FTP user by ID.

• id: Unique FTP user identifier.
• username: FTP base username.
• servers: Array of server IDs the FTP user has access to.

Apply partial updates (JSON Merge Patch) to mutable FTP user attributes.

Updatable fields:

• username: Change the FTP user's base username.
• password: Change the FTP user's password.

Notes:

• Fields omitted from the payload are not altered.

Permanently remove an FTP user.

Irreversible: ensure no servers require this FTP user before deletion.

Create a new end user by email (idempotent).

Behavior:

• If the email is new: a user record and login token are created.
• If the email exists: the existing user is returned with an existing flag.

Body fields:

• email: Unique email address (must be valid format).

Safe to call repeatedly with the same email without creating duplicates.