Download URL
Downloads content from the specified URI and returns the response. Makes an HTTP GET request to the URI specified in the request, optionally routing through a proxy. Custom headers can be provided to customize the request.
Downloads content from the specified URI and returns the response.
Makes an HTTP GET request to the URI specified in the request, optionally routing through a proxy. Custom headers can be provided to customize the request.
Preferred API authentication. Use a JWT with the api audience.
In: header
Path Parameters
The UUID of the SoulFire instance to associate this download with. Used for permission checking - the caller must have DOWNLOAD_URL permission for this instance. Must be a valid UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000").
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request message for downloading content from a URL through the SoulFire server. This allows clients to fetch remote resources using the server's network connection, optionally through a proxy, which is useful for accessing resources that may be blocked or rate-limited from the client's network.
The URI to download content from. Must be a valid, fully-formed URI (e.g., "https://example.com/resource.json"). The server will make an HTTP GET request to this URI.
uriOptional HTTP headers to include in the request to the target server. These headers are added on top of the default headers set by the server (Accept, Accept-Language, User-Agent). Custom headers can override defaults.
Optional proxy configuration for the download request. If not provided, the request will be made directly from the server. Supports HTTP, SOCKS4, and SOCKS5 proxies with optional authentication.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/downloads:fetch" \ -H "Content-Type: application/json" \ -d '{ "uri": "http://example.com" }'{ "data": "string", "headers": [ { "key": "string", "value": "string" } ], "statusCode": 0}How is this page?
Complete command POST
Retrieves tab-completion suggestions for a partial command. Uses Brigadier's completion system to generate context-aware suggestions based on the command structure and current cursor position. Permission requirements depend on the scope (same as ExecuteCommand).
Add instance account POST
Adds a Minecraft account to the instance. The account's profile_id must be unique within the instance.