Ship API

A robust, RESTful API that powers the CLI, Web, and your own custom integrations.

PUT /domains/staging

Request

{ "deployment": "pink-elephant-4ruf23f" }

201 Created

{
  "domain": "staging.shipstatic.dev",
  "deployment": "pink-elephant-4ruf23f",
  "url": "https://staging.shipstatic.dev",
  "labels": [],
  "verified": true,
  "created": "2026-01-15T..."
}

REST API

Powerful primitives.

Our API is designed for developers building the next generation of web infrastructure.

Full RESTful resource model
Strict input validation
Predictable rate limiting
API keys & deploy tokens

API Reference

Configuration as Code

One file. Full control.

Drop a ship.json in your project root to configure rewrites, redirects, and custom headers. No dashboard clicks, no deploy flags, just code.

SPA Rewrites

Route all paths to index.html for client-side routing.

Redirects

Permanent or temporary redirects with status codes.

Custom Headers

Set CORS, CSP, cache-control, and any other HTTP header.

Read the docs

ship.json

{
  "rewrites": [
    {
      "source": "/**",
      "destination": "/index.html"
    }
  ]
}

Ready to go live?

No extra charges, no surprise bills, nothing to maintain.

Get Started Free View on GitHub