Appium · Schema

Cookie

Browser cookie object from a WebDriver session

AndroidCross-PlatformiOSMobile TestingOpen SourceOpenJS FoundationTest AutomationWebDriver

Properties

Name	Type	Description
name	string	Cookie name
value	string	Cookie value
domain	string	Cookie domain
path	string	Cookie path
httpOnly	boolean	Whether the cookie is HTTP-only
secure	boolean	Whether the cookie requires HTTPS
expiry	integer	Cookie expiry as Unix timestamp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/appium/refs/heads/main/json-schema/appium-server-cookie-schema.json",
  "title": "Cookie",
  "description": "Browser cookie object from a WebDriver session",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Cookie name",
      "example": "session"
    },
    "value": {
      "type": "string",
      "description": "Cookie value",
      "example": "abc123"
    },
    "domain": {
      "type": "string",
      "description": "Cookie domain",
      "example": "example.com"
    },
    "path": {
      "type": "string",
      "description": "Cookie path",
      "example": "/"
    },
    "httpOnly": {
      "type": "boolean",
      "description": "Whether the cookie is HTTP-only",
      "example": false
    },
    "secure": {
      "type": "boolean",
      "description": "Whether the cookie requires HTTPS",
      "example": false
    },
    "expiry": {
      "type": "integer",
      "description": "Cookie expiry as Unix timestamp"
    }
  }
}