Welcome to our API Documentation

This site covers the Skip2 Networks Public REST API — endpoints, request & response schemas, authentication, rate limits, and code examples.

Looking for platform guides, tutorials, and configuration docs? Visit our main documentation site at docs.skip2.net ↗.

Skip2 Networks Public API

The Skip2 Networks Public API is a JSON-based RESTful interface that lets you manage every part of your Skip2 platform programmatically: sites, origins and load balancers, DNS, security rules (geo / bot / WAF), AddIn convenience rules, storage buckets, and cache purges.

All endpoints are versioned and mounted under /v1. The production base URL is:

https://api.skip2.net/v1

Quick start

  1. Enable API access for your account under Account -> API.

  2. Create an API key. The full secret is shown once – copy it immediately.

  3. Send the key on every request using the Authorization header:

    curl https://api.skip2.net/v1/account \
  -H "Authorization: Bearer sk2_a1b2c3d4e5f6a7b8.<secret>"

  4. You will receive a JSON envelope:

    {
  "success": true,
  "data": {
    "user_id": 1000,
    "email": "you@example.com",
    "organization": {"id": 1000, "name": "Acme", "plan": "business_payg"}
  }
}

Conventions

  • Envelopes. Every response is wrapped in a consistent envelope. Success responses contain success: true and a data object (and sometimes a meta object). Errors contain success: false and an error object.

  • Partial updates. PUT and PATCH requests update only the fields present in the body. Omitted fields are left unchanged.

  • HTTP methods. Collection endpoints accept GET (list) and POST (create). Item endpoints accept GET, PUT/PATCH and DELETE. Cache purge endpoints additionally accept the PURGE method.

  • Soft deletes. DELETE performs a soft delete; resources are retained for audit and recovery.

Contents