This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

Edit this Doc Status

Retrieve the server’s current status

Example Usage

driver.getStatus();

selenium.webdriver.common.utils.is_url_connectable(port)

// webdriver.io example
driver.status();

// wd example
await driver.status();

# ruby_lib example
remote_status

# ruby_lib_core example
@driver.remote_status

// 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	Espresso	?+	1.9.0+	All
	UiAutomator2	?+	1.6.0+	All
	UiAutomator	4.3+	All	All
Mac	Mac	?+	1.6.4+	All
Windows	Windows	10+	1.6.0+	All

Appium Clients

Language	Support	Documentation
Java	All	javadoc.io
Python	All	selenium-python.readthedocs.io
Javascript (WebdriverIO)	All
Javascript (WD)	All	github.com
Ruby	All	www.rubydoc.info
C#	All	github.com

HTTP API Specifications

Endpoint

GET /status

URL Parameters

None

JSON Parameters