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:
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | The Kiste's name. |
Responses:
200OK. Body: list of HostedServiceResponse
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:
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | The Kiste's name. |
Request body: CreateServiceRequest
| Field | Type | Required | Description |
|---|---|---|---|
description | string | no | |
name | string | yes | |
port | integer (int32) | yes |
Responses:
200OK. Body: HostedServiceResponse
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:
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | The Kiste's name. |
service | string | yes | The published port's ID. |
Responses:
200OK. Body: MessageResponse
Errors use the error envelope.