Skip to main content

API Reference

Quick Start​

The Workshop API uses Connect RPC for protobuf-based RPC.

To make an API call, first generate an API key in the API Keys page.

Using gRPC​

You can use grpcurl to experiment with the API:

$ grpcurl \
	-d '{"uuid": "00000000-0000-0000-0000-000000000000"}' \
	-H 'Authorization: npsws_sk_xxxxxxxxxxxxxx' \
	example.workshop.cloud:443 \
	workshop.v1.WorkshopService/GetHost
tip

If you see an HTTP 464 error or "malformed header: missing HTTP content-type" when making gRPC requests, try adding api. to the beginning of your domain e.g. api.example.workshop.cloud

Using HTTP​

You can use HTTP clients like curl to make API calls. Refer to the Connect documentation for more details.

Mutable methods must be called with a POST request:

$ curl \
	-X POST \
	-H 'Authorization: npsws_sk_xxxxxxxxxxxxxx' \
	--json '{"uuid": "00000000-0000-0000-0000-000000000000"}' \
	https://example.workshop.cloud/workshop.v1.WorkshopService/UpdateHost

Immutable methods can be called with a GET request:

$ curl \
	--get \
	--data-urlencode 'encoding=json' \
	--data-urlencode 'message={}' \
	-H 'Authorization: npsws_sk_xxxxxxxxxxxxxx' \
	https://example.workshop.cloud/workshop.v1.WorkshopService/ListAuditEvents
warning

API methods that support GET will have the following option:

option idempotency_level = NO_SIDE_EFFECTS;

API Methods​

For available API methods, see the workshop.proto reference.