Warning: JavaScript is not enabled or not loaded. Please enable JavaScript for the best experience.
Cloud API Platform
Menu
Get API Key

CloudAPI Platform

A RESTful API platform designed for seamless integration with your cloud infrastructure. Build, deploy, and scale applications with a modern, developer-friendly API built for enterprise reliability and performance.

Key Capabilities

  • →

    RESTful Architecture

    Standard HTTP methods with predictable JSON responses for straightforward integration and reduced development overhead.

  • →

    Real-time Data Streaming

    WebSocket support for live data feeds and event-driven architectures with minimal latency.

  • →

    Enterprise Security

    OAuth 2.0, API key management, and encrypted data transmission with compliance for GDPR and SOC 2.

  • →

    Rate Limiting & Quotas

    Flexible rate limiting policies with transparent quota tracking, monitoring, and usage analytics.

Quick Start

  1. 1. Create an API key in your account dashboard
  2. 2. Include your API key in the Authorization header of your requests
  3. 3. Start making requests to the API endpoints documented in the Endpoints section
  4. 4. Monitor your usage in the dashboard and adjust rate limits as needed

Sample Request & Response

GET /api/v1/resources

Request

curl -X GET https://api.cloudapi.io/v1/resources \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response (200 OK)

{
  "data": [
    {
      "id": "res_123abc",
      "name": "Production Server",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20
  }
}

Authentication

All requests to the API require authentication using an API key. The API key should be included in the Authorization header of every request using the Bearer authentication scheme.

API Key Authentication

Your API key is a unique identifier that authenticates your application to the platform. You can generate and manage your API keys from the developer dashboard.

  • Each API key is tied to a specific project or application
  • API keys have configurable rate limits and resource restrictions
  • Keys can be revoked or rotated at any time without downtime
  • Never share your API keys in public repositories or client-side code

Authorization Header Format

Include your API key in the Authorization header using the Bearer scheme:

Authorization: Bearer YOUR_API_KEY

Replace YOUR_API_KEY with your actual API key. All API endpoints require this header to be present.

Security Best Practices

Never expose API keys in client-side code

API keys should only be used in secure, server-side environments. If compromised, immediately revoke the key and generate a new one.

Use environment variables

Store API keys in environment variables or secure configuration management systems, never hardcode them in your application.

Rotate keys regularly

Periodically generate new API keys and retire old ones as part of your security maintenance routine.

Implement rate limiting

Configure rate limits for your API keys to prevent abuse and detect unusual activity patterns.

Code Example

Here's an example of how to make an authenticated request to the API: 

// Example: Making an authenticated API request
const apiKey = process.env.API_KEY;
const endpoint = 'https://api.platform.com/v1/resources';

const response = await fetch(endpoint, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Common Authentication Errors

401 Unauthorized Missing or invalid API key

Ensure the Authorization header is present and contains a valid, non-expired API key.

403 Forbidden Insufficient permissions

Your API key does not have permission to access this resource. Check your project's access control settings.

429 Too Many Requests Rate limit exceeded

You've exceeded your API rate limit. Implement exponential backoff and respect the Retry-After header.

API Endpoints

Below are the primary REST endpoints available in our cloud API platform. Each endpoint includes the HTTP method, path, description, and example requests and responses.

GET /v1/projects

List all projects

Retrieves a paginated list of all projects associated with your account. Supports filtering and sorting options.

Query Parameters

  • limit — Number of results to return (default: 20, max: 100)
  • offset — Pagination offset (default: 0)
  • status — Filter by status: active, archived, all

Example Response

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "Production App",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 42
  }
}
POST /v1/projects

Create a new project

Creates a new project under your account. Requires authentication and returns the created project object.

Request Body

{
  "name": "My New Project",
  "description": "Project description",
  "team_id": "team_xyz789"
}

Example Response

{
  "id": "proj_def456",
  "name": "My New Project",
  "description": "Project description",
  "team_id": "team_xyz789",
  "created_at": "2026-04-27T14:22:15Z",
  "status": "active"
}
GET /v1/usage

Get API usage statistics

Retrieves your account's API usage metrics for the current billing period, including request counts and rate limit status.

Query Parameters

  • project_id — Optional: filter usage by specific project
  • period — Time period: current, last_30_days, custom

Example Response

{
  "period": "2026-04-01T00:00:00Z to 2026-04-27T23:59:59Z",
  "total_requests": 1245680,
  "rate_limit": {
    "limit": 5000000,
    "remaining": 3754320,
    "reset_at": "2026-05-01T00:00:00Z"
  }
}
POST /v1/webhooks/test

Test webhook endpoint

Sends a test webhook payload to verify your webhook endpoint is configured correctly and reachable.

Request Body

{
  "webhook_url": "https://example.com/webhooks/events",
  "event_type": "project.created"
}

Example Response

{
  "success": true,
  "message": "Test webhook sent successfully",
  "response_code": 200,
  "delivery_time_ms": 145,
  "timestamp": "2026-04-27T14:25:30Z"
}

Authentication

All endpoints require authentication via API key. Include your API key in the request header: 

Authorization: Bearer your_api_key_here

Frequently Asked Questions

Find answers to common questions about our API platform, including rate limits, versioning, and support options.

What are the API rate limits?

Rate limits depend on your subscription tier. Free tier: 100 requests/minute. Standard: 1,000 requests/minute. Enterprise: custom limits. Rate limit information is returned in response headers: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

How is API versioning handled?

We use URL-based versioning (e.g., /api/v1/, /api/v2/). New versions are released with backward compatibility for at least 12 months. We announce deprecation timelines 6 months in advance via email and our status page at status.example.com.

How do I access the sandbox environment?

Sandbox access is available to all registered users. Use the endpoint https://sandbox-api.example.com with your API key. Sandbox data is reset daily at midnight UTC and supports all endpoints in read/write mode. No data persists between days, making it ideal for testing and development.

What error codes should I handle?

Common HTTP status codes: 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 500 (server error). All error responses include code and message fields. See the Endpoints section for detailed error handling and status codes.

How do webhook retries work?

Failed webhooks are retried with exponential backoff: 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, and 24 hours after the initial attempt. Webhook endpoints must return HTTP 2xx status within 30 seconds to be considered successful. After 6 consecutive failed attempts, the webhook is automatically disabled. Reactivate failed webhooks via the dashboard or using the PATCH /webhooks endpoint.

What support channels are available?

We offer email support at [email protected], a public community forum, GitHub discussions, and live chat for Enterprise customers. Response times: Standard tier (24–48 hours), Enterprise tier (4 hours). For critical production issues, contact our emergency line or file a P1 ticket in your dashboard.