Deploying
Custom subdomains
Pro accounts can claim a name like acme and show any drop they own at https://acme.ship.place/. Point it at another drop whenever you like: the drops keep their own slugs, URLs and revisions, and visitors see the switch within about 10 seconds. Point it at a named drop and it follows every redeploy.
On this page
Claim a name
/links
sp_ key or ID tokenSend the name, plus the drop to show as a slug or drop URL. Leave out slug to claim the name now and point it later. Claiming needs a verified Pro subscription: if billing can't be checked, the claim fails with a 503.
curl -X POST https://ship.page/links \
-H "Authorization: Bearer sp_QffDmo0..." \
-H "Content-Type: application/json" \
-d '{"name": "acme", "slug": "vivid-otter-a1b2c"}'{
"name": "acme",
"slug": "vivid-otter-a1b2c",
"url": "https://acme.ship.place/"
}| Status | Description |
|---|---|
400bad request | invalid_link_name or link_name_reserved: the name breaks the name rules. invalid_request: the body isn't a JSON object. |
402payment required | subscription_required: no active Pro plan on the account. |
404not found | drop_not_found: slug isn't a live drop on your account. |
409conflict | link_name_taken: someone else holds the name. link_exists: it's already yours, repoint it instead. link_limit_reached: you already hold all your plan allows (5 on Pro, 25 on Team). |
429rate limited | rate_limited: too many link changes. Claims, repoints and releases share one limit per account. |
503unavailable | backend_unavailable: billing couldn't be verified. Try again shortly. |
Check a name
/links/check
no authTells you if a name is free before you claim it. No key needed; requests are rate limited per IP. When available is false, reason is invalid, reserved or taken.
curl "https://ship.page/links/check?name=acme"
# { "name": "acme", "available": true }Point it elsewhere
/links/<name>
sp_ key or ID tokenSend another slug or drop URL and visitors get that drop within about 10 seconds. Set slug to null to unpoint: the name stays yours and serves a 404 until you point it again.
curl -X PATCH https://ship.page/links/acme \
-H "Authorization: Bearer sp_QffDmo0..." \
-H "Content-Type: application/json" \
-d '{"slug": "https://quiet-heron-k3m9p.ship.place/"}'{
"name": "acme",
"slug": "quiet-heron-k3m9p",
"url": "https://acme.ship.place/"
}| Status | Description |
|---|---|
402payment required | subscription_required: repointing needs an active Pro plan too. |
404not found | not_found: no link by that name on your account. drop_not_found: the target isn't a live drop on your account. |
409conflict | link_frozen: the link was taken down with its page. |
List your links
/links
sp_ key or ID tokenEvery link on the account. status is live, unpointed, paused or frozen; pauses_at is set once the paid plan has ended.
curl https://ship.page/links -H "Authorization: Bearer sp_QffDmo0..."{
"links": [
{
"name": "acme",
"url": "https://acme.ship.place/",
"slug": "quiet-heron-k3m9p",
"status": "live",
"pauses_at": null,
"created_at": "2026-11-03T20:40:00.000Z"
}
],
"limit": 5
}Release a name
/links/<name>
sp_ key or ID tokenFrees the name. For the next 30 days only you can claim it again. Works without an active plan.
curl -X DELETE https://ship.page/links/acme -H "Authorization: Bearer sp_QffDmo0..."
# { "released": "acme" }| Status | Description |
|---|---|
404not found | not_found: no link by that name on your account. |
409conflict | link_frozen: frozen links can't be released. |
Name rules
- Length
- 3-40 characters of
a-z,0-9and hyphens. - Hyphens
- Starts and ends with a letter or digit. No double hyphens.
- Slugs
- Can't look like a generated slug (
word-word-xxxxx) or match an existing one. - Reserved
- Infrastructure and service words (
www,api,mail,admin,status,docs,app,staging...), brand names and lookalikes (paypal,paypa1,rnicrosoft) and credential bait (login,verify,wallet,billing...). Names made only of reserved words, likenew-dashboard, are reserved too. - Per account
- Up to 5 on Pro, 25 on Team. Test a name with the name check before you claim it.
When your plan ends
Links keep serving for 30 days after your Pro or Team plan ends; claiming and repointing wait until you subscribe again. After that they pause and visitors get a 404 until you resubscribe. Your names are kept for 90 days without a plan, then released and held for 30 days so only you can claim them back.
Takedowns
If the page a link shows is taken down for abuse, the link is frozen with it: it serves the takedown notice and can't be repointed or released (409 link_frozen).
Last updated Jun 12, 2026