Skip to main content

Getting Started with Open Edge Cloud APIs

Welcome to the Open Edge Cloud API Documentation. This guide will help you get started with integrating OpenStack 2025.1 APIs into your applications.

🟢

Public Cloud API Documentation

This documentation includes only endpoints accessible to end users in Open Edge Cloud. Administrative and service-level endpoints have been filtered out based on security policies.

  • All operations require authentication via OpenStack Keystone
  • Users can only access resources within their own project/tenant
  • Some endpoints may return 403 Forbidden if accessed outside allowed scope

Overview​

Open Edge Cloud provides a complete OpenStack 2025.1 infrastructure with the following services:

  • Identity API (Keystone v3.14) - Authentication, authorization, and service catalog
  • Image API (Glance v2.16) - Virtual machine image management
  • Volume API (Cinder v3.71) - Persistent block storage volumes
  • Compute API (Nova) - Virtual machine lifecycle management (coming soon)
  • Network API (Neutron) - Software-defined networking (coming soon)
  • Object Storage API (Swift) - Scalable object storage (coming soon)

Authentication​

All API requests require authentication via OpenStack Keystone. You'll need:

  1. API Endpoint: Your Open Edge Cloud API endpoint URL
  2. Credentials: Username and password or application credentials
  3. Project: The project (tenant) context for your requests

Obtaining an Authentication Token​

curl -X POST https://api.us-east-1.open-edge.io/v3/auth/tokens \
  -H "Content-Type: application/json" \
  -d '{
    "auth": {
      "identity": {
        "methods": ["password"],
        "password": {
          "user": {
            "name": "your-username",
            "domain": {"name": "Default"},
            "password": "your-password"
          }
        }
      },
      "scope": {
        "project": {
          "name": "your-project",
          "domain": {"name": "Default"}
        }
      }
    }
  }'

The response will include an X-Subject-Token header containing your authentication token.

Making API Requests​

Once authenticated, include the token in subsequent requests:

curl -X GET https://api.us-east-1.open-edge.io/v2/images \
  -H "X-Auth-Token: your-token-here"

API Endpoints​

Rate Limits​

API requests are rate-limited to ensure fair usage:

  • Authentication: 10 requests per minute
  • Read operations: 100 requests per minute
  • Write operations: 50 requests per minute

Support​

Need help? Visit the Open Edge Cloud Dashboard or contact support.

Next Steps​

  • Learn about Identity API for authentication and authorization
  • Explore the Image API to manage virtual machine images
  • Discover the Volume API to create and manage block storage