{
  "message": "Warp Api Usage Guide",
  "homepage": "https://warp.cloudflare.now.cc/",
  "openapi": "https://warp.cloudflare.now.cc/openapi.json",
  "clients": [
    {
      "name": "Scalar Reference",
      "url": "https://warp.cloudflare.now.cc/docs",
      "description": "Documentation view for exploring API structure and examples"
    },
    {
      "name": "Swagger UI Client",
      "url": "https://warp.cloudflare.now.cc/client",
      "description": "Interactive API client for entering parameters and running requests online"
    }
  ],
  "usage": [
    {
      "run": "register",
      "description": "Register a new device",
      "params": [
        "team_token (optional)",
        "format (optional)"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=register&team_token=<Your-Team-Token>&format=<json|yaml|client|wireguard|warp-go|clash|xray|sing-box|qrencode>"
    },
    {
      "run": "device",
      "description": "Get details for a specific device",
      "params": [
        "device_id",
        "token"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=device&device_id=<Your-Device-ID>&token=<Your-Token>"
    },
    {
      "run": "app",
      "description": "Get client configuration",
      "params": [
        "token"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=app&token=<Your-Token>"
    },
    {
      "run": "bind",
      "description": "Bind a device to an account",
      "params": [
        "device_id",
        "token"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=bind&device_id=<Your-Device-ID>&token=<Your-Token>"
    },
    {
      "run": "name",
      "description": "Set the name of a device",
      "params": [
        "device_id",
        "token",
        "device_name"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=name&device_id=<Your-Device-ID>&token=<Your-Token>&device_name=<Your-Device-Name>"
    },
    {
      "run": "license",
      "description": "Set the license for a device",
      "params": [
        "device_id",
        "token",
        "license"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=license&device_id=<Your-Device-ID>&token=<Your-Token>&license=<Your-License>"
    },
    {
      "run": "unbind",
      "description": "Unbind a device from an account",
      "params": [
        "device_id",
        "token"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=unbind&device_id=<Your-Device-ID>&token=<Your-Token>"
    },
    {
      "run": "cancel",
      "description": "Cancel a device registration",
      "params": [
        "device_id",
        "token"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=cancel&device_id=<Your-Device-ID>&token=<Your-Token>"
    },
    {
      "run": "id",
      "description": "Convert and display client_id and reserved",
      "params": [
        "convert"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=id&convert=<4-char-string|Numbers1,Numbers2,Numbers3>"
    },
    {
      "run": "token",
      "description": "Get Cloudflare WARP Zero Trust Token",
      "params": [
        "organization",
        "email",
        "cf_appsession",
        "cf_session",
        "nonce",
        "code"
      ],
      "example": [
        {
          "step1": "https://warp.cloudflare.now.cc/?run=token&organization=<Your-Organization>&email=<Your-Email>"
        },
        {
          "step2": "https://warp.cloudflare.now.cc/?run=token&organization=<Your-Organization>&cf_appsession=<App-Session-Value>&cf_session=<Session-Value>&nonce=<Nonce-Value>&code=<Your-Code>"
        }
      ]
    },
    {
      "run": "key",
      "description": "Generate a pair of WireGuard public and private keys",
      "params": [
        "format (optional)"
      ],
      "example": "https://warp.cloudflare.now.cc/?run=key&format=<json|yaml>"
    },
    {
      "run": "stats",
      "description": "Get API usage statistics (daily and total)",
      "params": [],
      "example": "https://warp.cloudflare.now.cc/?run=stats"
    }
  ]
}