API Reference

Build integrations with Spidey Host. Complete API documentation.

Authentication

API Key Authentication

All requests require an API key in the Authorization header.

Authorization: Bearer your_api_key_here

Getting Your API Key

  1. 1. Log in to your Spidey Host account
  2. 2. Go to Settings → API Keys
  3. 3. Click "Generate New Key"
  4. 4. Copy and store your key securely

Endpoints

GET /api/v1/projects

List All Projects

Get a list of all your projects with metadata.

Response

{
"status": "success",
"data": [
{
"id": "proj_123abc",
"name": "my-app",
"url": "my-app.spidey.host",
"status": "online",
"created_at": "2024-02-20T10:30:00Z"
}
]
}
GET /api/v1/projects/:id

Get Project Details

Retrieve detailed information about a specific project.

Parameters

id (string, required) - The project ID
POST /api/v1/projects

Create Project

Create a new project. Automatically deployed after security review.

Request Body

{
"name": "my-app",
"repository": "github.com/user/repo",
"branch": "main"
}
PUT /api/v1/projects/:id

Update Project

Update project settings and environment variables.

DELETE /api/v1/projects/:id

Delete Project

Delete a project and all its associated data.

GET /api/v1/projects/:id/logs

Get Project Logs

Stream real-time logs from your deployed project.

Query Parameters

lines (integer) - Number of log lines to retrieve (default: 100)
stream (boolean) - Enable real-time streaming (default: false)

Webhooks

Webhook Events

Subscribe to events in your Spidey Host account.

deployment.started

Triggered when a deployment begins

deployment.completed

Triggered when a deployment finishes

deployment.failed

Triggered when a deployment fails

Error Handling

Error Response

{
"status": "error",
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid"
}
}

Need Help?

Check the full documentation or contact support.

View Docs