API docs by Redocly

5centsCDN API Documentation (2.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Welcome to the 5centsCDN API Documentation!

The 5centsCDN API provides a versatile and powerful interface to manage your CDN services. This documentation is organized by feature sections, allowing you to quickly locate relevant resources based on your use case.

Key Features

  • Livestreams: Tools to manage live streaming settings and resources.
  • Zones: Manage delivery zones for content distribution.
  • Encoding: Video encoding options for optimized playback.
  • SimpleDNS: DNS management with seamless configuration.
  • Traffic Director: Advanced routing and traffic management.
  • VideoPlayer & Analytics: Embed players and track content performance.
  • Accounts: Manage account settings, access levels, and billing.
  • Edge Rules: Custom rules for controlling CDN edge behavior.
  • YouTube Sync: Take a backup of users' YouTube Accounts

Each section includes detailed endpoints, parameters, and example requests and responses to help you build effectively.

Base URL

The base URL for all 5centsCDN API requests:

  • https://api.5centscdn.com/v2

Authorization

To authenticate your requests, include your API key in the X-API-KEY header:

X-API-KEY: YOUR_API_KEY

Replace YOUR_API_KEY with the API key provided by 5centsCDN.

HTTP Status Codes

The API uses standard HTTP status codes to indicate the success or failure of requests:

  • 200 OK: The request was successful.
  • 201 Created: A new resource was successfully created.
  • 400 Bad Request: The request was invalid or missing parameters.
  • 401 Unauthorized: Authentication failed or API key is missing/invalid.
  • 403 Forbidden: You do not have permission to access this resource.
  • 404 Not Found: The requested resource does not exist.
  • 429 Too Many Requests: You have exceeded the request rate limit.
  • 500 Internal Server Error: An error occurred on our server.

Response Format

All API responses are returned in JSON format, including errors. Each response will include:

  • status: Indicates success or error status.
  • data: Contains the requested information or result.
  • error: (If applicable) Provides error details, such as code and message.

Error Handling

In case of an error, the response will include:

  • status: Error status code.
  • error: Object containing code and message fields to describe the error.