SeaGit API

Overview

SeaGit exposes a complete REST API for managing infrastructure, deployments, and account resources. The API is described by an OpenAPI 3.0 spec — download it to integrate with Postman, Insomnia, or any HTTP client or code generator.

Authentication

Every API request must include an Authorization header. The value is the raw API key — no Bearer prefix or other scheme.

API Keys (Recommended)

API keys are long-lived, revocable, and belong to a single account. Create your first one under Settings → API keys (/settings/api-keys) or via the API:

$ curl -X POST https://seagit.com/api/accounts/YOUR_ACCOUNT_ID/api-keys \
  -H "Authorization: $SEAGIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-automation"}'

# Returns the raw key once:
{
  "success": true,
  "data": {
    "id": "...",
    "name": "my-automation",
    "key": "sgt_live_...",
    "created_at": "2025-01-15T10:00:00Z"
  }
}

Save the returned key value (printed once); it is never displayed again. Revoke a key by deleting it under Settings.

Session Tokens (Testing)

When signed into the dashboard, your browser session token is automatically used by the interactive Swagger explorer. You can also extract and use your session token for curl requests during development.

Quickstart

Get your account ID and make your first API request:

# Set up your environment
export SEAGIT_API=https://seagit.com/api
export SEAGIT_API_KEY=sgt_live_xxx...

# Verify your API key is valid; fetch your account
curl -H "Authorization: $SEAGIT_API_KEY" \
  $SEAGIT_API/auth/me

# Response includes your account ID in data._id
{
  "success": true,
  "data": {
    "_id": "account123",
    "email": "user@example.com",
    ...
  }
}

# Save your account ID
export ACCOUNT_ID=account123

# List your applications
curl -H "Authorization: $SEAGIT_API_KEY" \
  $SEAGIT_API/accounts/$ACCOUNT_ID/apps

Endpoint Groups

The API is organized into logical groups. Click any group to explore it in the interactive explorer.

Responses and Errors

Success Response

Successful requests return a 2xx status (usually 200; some create calls return 201) with a JSON body:

{
  "success": true,
  "data": { ... }
}

Error Response

Errors return an HTTP status code and a JSON body with an error message:

{
  "success": false,
  "error": "error message"
}

Common Status Codes

• 200 OK — Request succeeded.
• 201 Created — Resource created successfully (POST requests).
• 400 Bad Request — Missing or invalid request body.
• 401 Unauthorized — Missing, invalid, expired or disabled credentials. Send a valid API key in the Authorization header.
• 403 Forbidden — Insufficient permissions or feature not available on your plan (e.g., API keys on Free plan).
• 404 Not Found — Resource does not exist.
• 405 Method Not Allowed — Endpoint does not support that HTTP method.
• 500 Server Error — Internal server error. Try again; contact support if it persists.

Individual endpoints may use additional status codes. See the interactive Swagger explorer for per-endpoint details.

Limits

• API keys — Available on paid plans only. Creating a key on the Free plan returns 403 Forbidden.
• Request/response bodies — Free-form JSON. The OpenAPI spec lists the fields each endpoint reads; not all fields are validated or documented, so refer to the spec.
• Versioning — The API is not versioned and can change along with the dashboard. Pin your client to the spec you generated it from and regenerate when you update.
• No official SDKs — Use any HTTP client (curl, Python requests, JavaScript fetch) or OpenAPI code generator (openapi-generator, swagger-codegen). The spec is the source of truth.
• No sandbox — All API calls act on real resources in your live environment. Test cautiously.
• Rate limits — No rate limits are documented. Keep request volume reasonable and contact support if you run into limits.

FAQ