Home
/
Reference
/
REST API
/
WorkspaceProxies

WorkspaceProxies

Get site-wide regions for workspace connections

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/regions \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /regions

Example responses

200 Response

{
	"regions": [
		{
			"display_name": "string",
			"healthy": true,
			"icon_url": "string",
			"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
			"name": "string",
			"path_app_url": "string",
			"wildcard_hostname": "string"
		}
	]
}

Responses

StatusMeaningDescriptionSchema
200OKOKcodersdk.RegionsResponse-codersdk_Region

To perform this operation, you must be authenticated. Learn more.

See an opportunity to improve our docs? Make an edit.