ShipStatic Docs llms.txt llms-full.txt

Deployments

A deployment is an immutable snapshot of static files. Once created, its contents never change.

Every deployment gets a unique ID (e.g. pink-elephant-4ruf23f) and an instant preview URL.

Properties

Property Description
deployment Unique identifier
url Preview URL, immediately accessible
files Number of files
size Total size in bytes
status Lifecycle state (see below)
labels Mutable tags for organization
via How it was created: cli, sdk, web
created Creation timestamp
expires Expiration timestamp (free-tier deployments only)

Status

pending → success
        → failed
success → deleting

A deployment starts as pending during upload. On success, the preview URL goes live. Deletion is asynchronous - the status transitions to deleting while files are cleaned up.

Behaviors

Immutable. After creation, only labels can be modified. To change content, create a new deployment.

Path optimization. When all files share a common root directory (e.g. dist/), the platform flattens it automatically - dist/index.html becomes index.html.

SPA detection. The platform analyzes your index.html for single-page app patterns (React Router, Vue Router, etc.) and configures client-side routing fallbacks automatically.

Labels

Labels organize and filter deployments. Each label is 3–63 lowercase alphanumeric characters with ., -, or _ separators. Maximum 10 per deployment.

production
v1.0.3
staging.preview

Operations

Operation Description
Upload Create a new deployment from files
List All deployments on your account
Get Details of a specific deployment
Set Update labels
Remove Delete a deployment and its files