API Documentation

RESTful API, S3-compatible storage, and SDKs for popular languages

Getting Started

The HifzNet API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

https://api.hifznet.tech/v1

Authentication

Authenticate your API requests using Bearer tokens. Include your API key in the Authorization header.

Example Request
curl -X POST https://api.hifznet.tech/v1/backup/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "/data/documents",
    "encryption": "aes-256-gcm",
    "region": "eu-west-1"
  }'

Endpoints

GET /v1/backup/list

List all backups for authenticated user

Response: 200 OK
{ "backups": [...], "total": 42 }

POST /v1/backup/upload

Create new backup

Response: 201 Created
{ "backup_id": "...", "status": "processing" }

GET /v1/backup/:id

Get backup details

Response: 200 OK
{ "id": "...", "created_at": "...", "size": 1234567 }

DELETE /v1/backup/:id

Delete backup

Response: 204 No Content

SDKs

Official SDKs available for Python, Node.js, and Go.

Python

pip install hifznet

Node.js

npm install hifznet

Go

go get hifznet.tech/sdk