ZOIKO WEB SERVICES

API reference

OVERVIEW
Introduction Authentication Errors
PROJECTS
GET List projects POST Create project
DEPLOYMENTS
GET Get deployment POST Create deploy DEL Delete deploy

API reference

The Zoiko REST API lets you manage projects, deployments, and configuration
programmatically. Placeholder spec — replace endpoints and fields with your real API.

The Zoiko REST API lets you manage
projects, deployments, and configuration
programmatically. Placeholder spec —
replace endpoints and fields with your
real API.

Base URL https://api.zoikoweb.com/v1

Introduction

All requests use HTTPS and return JSON. Timestamps are ISO 8601. The API is versioned in the
path (/v1)

All requests use HTTPS and return JSON.
Timestamps are ISO 8601. The API is
versioned in the path (/v1)

Authentication

Authenticate with a bearer token from your dashboard. Include it in the Authorization header on
every request.

Authenticate with a bearer token from your
dashboard. Include it in the Authorization
header on every request.

Authorization header
Authorization: Bearer YOUR_API_TOKEN

Errors

The API uses standard HTTP status codes. Errors return a JSON body with a code andmessage

The API uses standard HTTP status codes.
Errors return a JSON body with a code and
message

Status Meaning
400 Bad request — invalid parameters
401 Unauthorized — missing or invalid token
404 Not found
429 Rate limited
500 Server error
Status Meaning
400 Bad request — invalid parameters
401 Unauthorized — missing or invalid
token
404 Not found
429 Rate limited
500 Server error

List projects

GET /v1/projects

Returns a paginated list of projects for the authenticated account.

Query Param Type Description
limit integer Max items (default 20, max 100)
cursor string Pagination cursor
Query Param Type Description
limit integer Max items (default
20, max 100)
cursor string Pagination cursor
cURL JavaScript
Request
curl https://api.zoikoweb.com/v1/projects \
  -H "Authorization: Bearer $TOKEN"
Response  200 OK
{
  "data": [
    { "id": "prj_123", "name": "my-app" }
  ],
  "next": null
}

Create project

POST /v1/projects
Body Field Type Description
namerequired string Project name
region string Deployment region
Request
curl; -X POST https://api.zoikoweb.com/v1/projects \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"name":"my-app"}'
Response  201 Created
{
  "id": "prj_456",
  "name": "my-app",
  "created": "2026-06-01T10:00:00Z"
}

Get deployment

GET /v1/deployments/{id}

Retrieve the status and metadata of a deployment.

Response  200 OK
{
  "id": "dep_789",
  "status": "ready",
  "url": "https://my-app.zoikoweb.app"
}

Create deployment

POST /v1/deployments

Trigger a new deployment for a project.

DELETE Delete deployment
DELETE /v1/deployments/{id}

Remove a deployment. Returns 204 No Content on success.

DELETE Delete deployment
DELETE /v1/deployments/{id}

Remove a deployment. Returns 204 No Content on success.