API Reference

Update a dock

Partially updates a dock’s own record: its name, colour, notes, drone manifest, catalog model, address, coordinates, last-opened timestamp, or soft-deleted flag. Only fields present in the body are validated and applied; an unknown field is ignored, not rejected, and latitude and longitude travel as a pair. Use it for owner-side edits, not for command or control of the physical hardware, which is a separate surface (the dock-control operations). Who may call it depends on what is sent: an Operator (member) or above in the owning organization may change every field except deleted, which takes an admin or owner. The response mirrors that rule in canEditDock and canManage, so a client can hide what a caller cannot do. Network visibility is deliberately not editable here: which network can see a dock is a staff action.

`PATCH /api/docks/{id}`

Production: PATCH https://outpost.earthity.com/api/docks/{id}
Gate: session
Read-only: false
Destructive: false
Idempotent: false

Parameters

Name	In	Required	Type	Description
`id`	path	yes	`string`	The dock’s slug (callsign) or cuid.

Request body

Property	Type	Required	Constraints	Description
`name`	`string`	no	maxLength: 200	The per-organization label. The two-word callsign underneath never changes.
`address`	`string`	no	maxLength: 300
`dockCatalogId`	`string or null`	no	maxLength: 64	Which catalog dock model this unit is. A soft reference to a catalog entry with no foreign key, so an id that names nothing is stored as sent. Send null to clear it; an empty string is refused, so there is one spelling of “no model”.
`latitude`	`number`	no	minimum: -90; maximum: 90
`longitude`	`number`	no	minimum: -180; maximum: 180
`color`	`string or null`	no	maxLength: 32	Card colour. `null` returns the card to the default.
`notes`	`array or null`	no	-	Free-form note entries, at most 200 and 200 KB in total. `null` clears them.
`droneManifest`	`array or null`	no	-	Which airframes fly from this dock, and how many of each. `null` clears it. Unknown keys on an entry are dropped.
`deleted`	`boolean`	no	-	Soft delete (`true`) or restore (`false`). Admin or owner only.
`lastInteractedAt`	`string or null`	no	format: date-time	When the dock was last opened in the dashboard; drives Home ordering. `null` means never.

Example

{
  "name": "Rooftop Alpha (East)"
}

Responses

`200` - The updated dock.

Property	Type	Required	Constraints	Description
`id`	`string`	no	-
`callsign`	`string`	no	-	Two-word callsign: the stored slug for real docks, derived from the id for synthetic rows.
`name`	`string`	no	-
`dockNumber`	`integer`	no	-	The per-organization ordinal behind the `Dock-00N` label. Unique within the owning organization and never reused.
`sourcePinClientId`	`string or null`	no	-	The dashboard placement pin this dock was created from, or `null` for a dock that came from no pin. Lets a dashboard show the pin and the dock as one card.
`isPlanned`	`boolean`	no	-	True for a dock the organization has placed but whose hardware does not exist yet. A planned dock is editable but never commandable, and never appears outside its owning organization.
`rooftop`	`object or null`	no	-	The dock’s Site (legacy name retained). Null when the dock has been provisioned with no location yet; set later by the customer in settings.
`latitude`	`number or null`	no	-	Null together with longitude when the dock has no location yet.
`longitude`	`number or null`	no	-	Null together with latitude when the dock has no location yet.
`status`	`string`	no	-	Open set; stored status only, not derived from live occupancy.
`pricePerMinute`	`number or null`	no	-	Null when not yet priced, distinct from 0, which is a deliberately free dock.
`createdAt`	`string`	no	format: date-time
`earningsToDate`	`number`	no	-	Always 0 until the v2 booking backend lands.
`commandable`	`boolean`	no	-	Whether this caller may command the dock right now: a machine is wired to it, and the credential is entitled to actuate it (Operator or above in the owning organization, a command grant, or the open network). Per caller. The actuation operations under /api/v1/docks/`{dockId}`/commands only succeed when this is true; the machine address itself never crosses the wire.
`hasCamera`	`boolean`	no	-	Whether this caller may watch the live pad camera: a camera module is fitted, a machine is wired, and the caller may command the dock. Per caller, like `commandable`.
`canEditDock`	`boolean`	no	-	Whether this caller may edit the dock’s record (Operator or above in the owning organization). Per caller.
`canManage`	`boolean`	no	-	Whether this caller may delete the dock (admin or owner of the owning organization). Per caller.

`rooftop`

Property	Type	Required	Constraints	Description
`id`	`string`	no	-
`address`	`string`	no	-

`400` - One of the provided fields failed validation.

Body: application/problem+json - see Problem anatomy.

`401` - Not signed in.

Body: application/problem+json - see Problem anatomy.

`403` - Demo mode is read-only, or the caller’s role in the owning organization is too low for the fields sent: `deleted` needs an admin or owner, every other field an Operator (`member`) or above. A viewer, or a member of another organization, cannot edit at all.

Body: application/problem+json - see Problem anatomy.

`404` - No dock matches that slug/id.

Body: application/problem+json - see Problem anatomy.

`429` - Too many mutating requests from this IP: 30 per 10 seconds across the API. Carries `Retry-After`. This route sits outside the dock-control plane, so the body is the legacy shape rather than problem+json.

Body: application/json - see Legacy error body.

Get started

Dashboard

API Reference

Errors

Update a dock

`PATCH /api/docks/{id}`

Parameters

Request body

Example

Responses

`200` - The updated dock.

`rooftop`

`400` - One of the provided fields failed validation.

`401` - Not signed in.

`403` - Demo mode is read-only, or the caller’s role in the owning organization is too low for the fields sent: `deleted` needs an admin or owner, every other field an Operator (`member`) or above. A viewer, or a member of another organization, cannot edit at all.

`404` - No dock matches that slug/id.

`429` - Too many mutating requests from this IP: 30 per 10 seconds across the API. Carries `Retry-After`. This route sits outside the dock-control plane, so the body is the legacy shape rather than problem+json.

Errors

​PATCH /api/docks/{id}

​Parameters

​Request body

​Example

​Responses

​200 - The updated dock.

​rooftop

​400 - One of the provided fields failed validation.

​401 - Not signed in.

​403 - Demo mode is read-only, or the caller’s role in the owning organization is too low for the fields sent: deleted needs an admin or owner, every other field an Operator (member) or above. A viewer, or a member of another organization, cannot edit at all.

​404 - No dock matches that slug/id.

​429 - Too many mutating requests from this IP: 30 per 10 seconds across the API. Carries Retry-After. This route sits outside the dock-control plane, so the body is the legacy shape rather than problem+json.

​Errors

`PATCH /api/docks/{id}`

Parameters

Request body

Example

Responses

`200` - The updated dock.

`rooftop`

`400` - One of the provided fields failed validation.

`401` - Not signed in.

`403` - Demo mode is read-only, or the caller’s role in the owning organization is too low for the fields sent: `deleted` needs an admin or owner, every other field an Operator (`member`) or above. A viewer, or a member of another organization, cannot edit at all.

`404` - No dock matches that slug/id.

`429` - Too many mutating requests from this IP: 30 per 10 seconds across the API. Carries `Retry-After`. This route sits outside the dock-control plane, so the body is the legacy shape rather than problem+json.

Errors