Skip to main content

GET /

Example: GET https://your.battlesnake.com/

An empty GET request made to the top-level URL of your Battlesnake, used for customization, checking latency, and verifying successful communications between the Battlesnake and the Battlesnake Engine.

Parameters

ResponsesType
🟢 200application/json
{
"apiversion": "1",
"author": "MyUsername",
"color": "#888888",
"head": "default",
"tail": "default",
"version": "0.0.1-beta"
}

Response Properties

ParameterTypeDescription
apiversionstring (required)Version of the Battlesnake API implemented by this Battlesnake. Currently only API version 1 is valid. Example: "1"
authorstring (optional)Username of the author of this Battlesnake. If provided, this will be used to verify ownership.Example: "BattlesnakeOfficial"
colorstring (optional)Hex color code used to display this Battlesnake. Must start with "#" and be 7 characters long.Example: "#888888"
headstring (optional)Displayed head of this Battlesnake. See Customization Guide for available optionsExample: "default"
tailstring (optional)Displayed tail of this Battlesnake. See Customization Guide for available options.Example: "default"
versionstring (optional)A version number or tag for your snake.

See Customization Guide for available colors, heads, and tails.