API reference

Kiste Stream

Publish a port of a Kiste at its own address under kiste.stream, list and revoke it.

Publish a port of a Kiste at its own address under kiste.stream, list and revoke it.

List published ports

GET /v1/instances/{name}/services

The ports of this Kiste published on Kiste Stream, with their public addresses.

Path parameters:

NameTypeRequiredDescription
namestringyesThe Kiste's name.
curl -sS "https://kiste.run/v1/instances/review-42/services" \
  -H "Authorization: Bearer $KISTE_TOKEN"

Responses:

Errors use the error envelope.

Publish a port

POST /v1/instances/{name}/services

Publishes a port of the Kiste at its own address https://<label>.kiste.stream/, where the label is a long random capability. Anyone with the address reaches the port over HTTP and WebSocket until you revoke it. description says what runs there.

Path parameters:

NameTypeRequiredDescription
namestringyesThe Kiste's name.
curl -sS -X POST "https://kiste.run/v1/instances/review-42/services" \
  -H "Authorization: Bearer $KISTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"web","port":3000,"description":"Dev server"}'

Request body: CreateServiceRequest

FieldTypeRequiredDescription
descriptionstringno
namestringyes
portinteger (int32)yes

Responses:

Errors use the error envelope.

Revoke a published port

DELETE /v1/instances/{name}/services/{service}

Ends a published port; its address stops working at once and is never reused.

Path parameters:

NameTypeRequiredDescription
namestringyesThe Kiste's name.
servicestringyesThe published port's ID.
curl -sS -X DELETE "https://kiste.run/v1/instances/review-42/services/SERVICE_ID" \
  -H "Authorization: Bearer $KISTE_TOKEN"

Responses:

Errors use the error envelope.

On this page