Status
Retrieve the server’s current status
Example Usage
// TODO
selenium.webdriver.common.utils.is_url_connectable(port)
// webdriver.io example
driver.status();
// wd example
await driver.status();
# TODO
// TODO
// TODO
Description
Returns information about whether a remote end is in a state in which it can create new sessions and can additionally include arbitrary meta information that is specific to the implementation.
The readiness state is represented by the ready property of the body, which is false if an attempt to create a session at the current time would fail. However, the value true does not guarantee that a New Session command will succeed.
Implementations may optionally include additional meta information as part of the body, but the top-level properties ready and message are reserved and must not be overwritten.
Support
Appium Server
Platform | Driver | Platform Versions | Appium Version | Driver Version |
---|---|---|---|---|
iOS | XCUITest | 9.3+ | 1.6.0+ | All |
UIAutomation | 8.0 to 9.3 | All | All | |
Android | UiAutomator2 | ?+ | 1.6.0+ | All |
UiAutomator | 4.2+ | All | All | |
Mac | Mac | ?+ | 1.6.4+ | All |
Windows | Windows | 10+ | 1.6.0+ | All |
Appium Clients
Language | Support | Documentation |
---|---|---|
Java | All | |
Python | All | selenium-python.readthedocs.io |
Javascript (WebdriverIO) | All | webdriver.io |
Javascript (WD) | All | github.com |
Ruby | All | www.rubydoc.info |
PHP | All | github.com |
C# | All | github.com |
HTTP API Specifications
Endpoint
GET /wd/hub/status
URL Parameters
None
JSON Parameters
None
Response
name | type | description |
---|---|---|
build.version | string |
A generic release label (i.e. "2.0rc3") |
build.revision | string |
The revision of the local source control client from which the server was built |