Skip to main content
POST
/
custom
Run Test on Custom Server
curl --request POST \
  --url https://api.hixbe.com/speedtest/custom \
  --header 'Content-Type: application/json' \
  --header 'Hixbe-Version: <hixbe-version>' \
  --data '{
  "serverId": 1
}'
{
  "success": true,
  "timestamp": "2023-11-07T05:31:56Z",
  "executionTime": "<string>"
}
Executes a custom speed test with user-defined parameters and test options.

Headers

Hixbe-Version
string
required

API version header. Required for all endpoints except / and /health

Pattern: ^\d+\.\d+\.\d+$
Example:

"2.0.0"

Body

application/json
serverId
integer
required

ID of the test server to use

Required range: x >= 1
Example:

1

Response

Custom server test completed successfully

success
boolean
timestamp
string<date-time>
data
object
executionTime
string