Get service status

Client version1.8.0 (latest)1.7.0Version overview

GET

Example base URLhttp://local.zhongyibrowser.com:39025http://127.0.0.1:39025/api/v1/status

No API key is required. Checks whether the local service is running.

Request parameters

This endpoint does not require an API Key.

Request code examples

JavaScript / TypeScript: Node.js 18+ with fetch; PHP: cURL extension; Go: 1.16+; Java: JDK 11+. Replace the token and example parameter values before running.

curl 'http://local.zhongyibrowser.com:39025/api/v1/status'

fetch("http://local.zhongyibrowser.com:39025/api/v1/status", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "GET",
    "headers": {}
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/status", options)
  const data: unknown = await response.json()
  console.log(data)
}

main().catch(console.error)

<?php
$ch = curl_init('http://local.zhongyibrowser.com:39025/api/v1/status');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
if ($response === false) {
  throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response . PHP_EOL;

package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "http://local.zhongyibrowser.com:39025/api/v1/status", nil)
	if err != nil {
		log.Fatal(err)
	}

	response, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer response.Body.Close()

	data, err := io.ReadAll(response.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/status"))
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

import requests

url = "http://local.zhongyibrowser.com:39025/api/v1/status"

response = requests.get(url)
print(response.json())

Responses

Success: code = 0. Failure: code > 0. Select a status to view its fields and example. Expand objects to inspect nested fields. Optional fields may be omitted.

Service status

Body

Response content typeapplication/jsonStatusSuccessResponse

Fields

›numberrequired

Business status code; always 0 on success

Enum

›stringrequired

Business status message; always success on success

Enum

›objectrequired

Endpoint business data

Additional fields are not allowed.

Example

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "service": "running",
    "version": "string",
    "port": 39025,
    "base_url": "string",
    "auth_required": true,
    "backend_session": "available",
    "browser_count": 0,
    "started_at": "2024-01-15T09:30:00Z"
  }
}

View all business error codes and HTTP statuses