API documentation
    • Introduction
    • Error guide
    • Quickstart guide
    • API Directory
      • Datacenter
      • File and Folder
        • File
        • Folder
      • Region
      • Storage
        • Status
    • Welcome
      GET

    Introduction

    Introduction#

    The Everabyte Cloud Storage API lets your applications interact directly with secure, scalable cloud storage using simple RESTful HTTP endpoints. It is designed to make file and directory management efficient, reliable, and secure for a wide range of use cases.
    With this API, you can:
    Upload and download files programmatically
    Create and manage directories
    Read and update file, folder, and custom metadata
    All stored data is protected with encryption at rest and in transit, so your information stays confidential while remaining accessible from anywhere.

    Why Use the Everabyte Cloud Storage API?#

    This API is built for projects that need reliable, flexible storage, from small apps to large enterprise systems.
    Key benefits:
    Easy integration: Connect directly with existing services, backends, and automation workflows using standard HTTP calls.
    Scalable by design: Increase storage capacity as your data grows, without changing application logic.
    Strong security: Protect sensitive data using enterprise-grade encryption and authenticated access.
    Fine-grained control: Manage files, folders, permissions, and metadata through clear, well-structured endpoints.

    Getting Started#

    To call the Everabyte Cloud Storage API, you must authenticate with an API key.
    Steps to obtain a key:
    Create an account on the Everabyte platform
    Open the API Settings section in your dashboard
    Generate and securely store your unique API key, then include it in your requests as specified in the authentication section of the full API docs

    Base URL#

    All endpoints are accessed under this base URL:
    https://api.everabyte.io/api
    Include this prefix before each endpoint path when making requests.

    Standardized Error Codes#

    The API returns consistent HTTP status codes with JSON payloads to describe the outcome of each request.
    CodeDescriptionExample Response
    200OK: The request completed successfully.{ "status": "OK" }
    201Created: A new resource was created.{ "status": "Created", "data": { ... } }
    204No Content: Success, but no response body.{}
    400Bad Request: The request is malformed.{ "error": "Bad Request" }
    401Unauthorized: Authentication is missing/invalid.{ "error": "Unauthorized" }
    401.1Invalid API Key: The provided key is invalid.{ "error": "Invalid API Key" }
    401.2Expired API Key: The provided key is expired.{ "error": "Expired API Key" }
    403Forbidden: The client lacks required rights.{ "error": "Forbidden" }
    404Not Found: The resource does not exist.{ "error": "Not Found" }
    409Conflict: The request conflicts with current state.{ "error": "Conflict" }
    429Too Many Requests: Rate limit exceeded.{ "error": "Too Many Requests" }
    500Internal Server Error: An unexpected error occurred.{ "error": "Internal Server Error" }
    For more detailed guidance on handling these errors in your code, refer to the Error Handling Guide in the main documentation.
    Modified at 2026-05-12 13:22:07
    Next
    Error guide
    Built with