Service URL

HTTP and WebSocket access to a sandbox's services, and shareable signed URLs.

On this page: REST · SDK

REST#

Call a service#

GET /api/svc/{namespace}/{service}/{path}

Parameter	In	Description
`namespace`	path	The pool's namespace. A pool, its namespace and its template share one name.
`service`	path	The Kubernetes Service of the sandbox service: `<sandbox>-<service>`.
`path`	path	The upstream path, forwarded verbatim (it must start with `/`). Optional.

Returns: 200. Upstream response.

Errors: 400, 401, 403, 502 (Errors).

Create a signed URL#

POST /api/signed-service-urls/{namespace}

Creates a temporary bearer link for one logical sandbox service.

Parameter	In	Description
`namespace`	path	The pool's namespace. A pool, its namespace and its template share one name.

Body (application/json):

Field	Type	Default	Description
`claim`	`string`	required	The claim that holds the sandbox.
`expiresInSeconds`	`integer`	required	Lifetime of the URL, in seconds. 60 to 86400.
`label`	`string`	none	A label for the URL, at most 120 UTF-8 bytes. At most 120 characters.
`logicalService`	`string`	required	The service as the template names it, for example `env`.
`sandbox`	`string`	required	The sandbox name (`status.sandbox.name` of the claim).
`service`	`string`	required	The sandbox's Service: `<sandbox>-<logicalService>`.

Returns: 201 with an object with claim (string), createdAt (string), expiresAt (string), id (string), label (string), logicalService (string), namespace (string), revokedAt (string), sandbox (string), service (string), url (string).

Errors: 400, 401, 404, 500, 503 (Errors).

List signed URLs#

GET /api/signed-service-urls/{namespace}

Parameter	In	Description
`namespace`	path	The pool's namespace. A pool, its namespace and its template share one name.
`claim`	query	The claim name.

Returns: 200 with an array; each item is an object with claim (string), createdAt (string), expiresAt (string), id (string), label (string), logicalService (string), namespace (string), revokedAt (string), sandbox (string), service (string), url (string).

Errors: 400, 401, 500, 503 (Errors).

Revoke a signed URL#

DELETE /api/signed-service-urls/{namespace}/{id}

Parameter	In	Description
`namespace`	path	The pool's namespace. A pool, its namespace and its template share one name.
`id`	path	The object id.

Returns: 204. No Content.

Errors: 400, 401, 404, 500, 503 (Errors).

SDK#

Methods of the Fleet handle (cua.fleet()), with signatures in every language in the Cua SDK reference.

Method	Returns	Description
`Fleet.service_url(sandbox, service)`	`string`	The gateway URL of a sandbox service (needs the Fleet bearer).
`Fleet.create_signed_service_url(sandbox, service, label, expires_in_seconds)`	`FleetSignedUrl`	Mints a signed, shareable service URL.