Sign in
Platform

Get information about how the service is being accessed

Returns details about the server's access mode, public IP address, private IP address, and domain creation capabilities. Both IP addresses are always included when available.

get/platform/access-info

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/platform/access-info
  • Auth: HTTP bearer

Response

Service access information

access_modestring required

Mode of access: "local", "direct", "nat", or "cloudflare_tunnel"

can_create_domainsboolean required

Whether domain creation is allowed in this mode

domain_creation_errorstring nullable

Error message if domain creation is not allowed

private_ipstring nullable

Server's private/local IP address (always returned if available)

public_ipstring nullable

Server's public IP address (always returned if available)

Changes

No recorded changes to this operation across all 50 revisions of this API.