---
title: "API Reference - Workshop Docs"
description: "API Reference - Enterprise control plane for Santa. Manage rules, approvals, telemetry, and policies across your macOS fleet."
doc_version: "1"
last_updated: "2026-05-22"
canonical: "https://northpole.security/docs/workshop/api"
---
# API Reference

## Quick Start

The Workshop API uses [Connect RPC](https://connectrpc.com/) for [protobuf](https://protobuf.dev/)\-based RPC.

To make an API call, first generate an API key in the [API Keys](./api-keys) page.

### Using gRPC

You can use [grpcurl](https://github.com/fullstorydev/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
```

### Using HTTP

You can use HTTP clients like `curl` to make API calls. Refer to the [Connect documentation](https://connectrpc.com/docs/curl-and-other-clients) 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
```

## API Methods

For available API methods, see the [workshop.proto reference](https://buf.build/northpolesec/workshop-api/docs/main:workshop.v1#workshop.v1.WorkshopService).

## Sitemap

- [Home](https://northpole.security/index.md)
- [Workshop](https://northpole.security/workshop.md)
- [Santa](https://northpole.security/santa.md)
- [Features](https://northpole.security/features.md)
- [Cookbook](https://northpole.security/cookbook.md)
- [Docs](https://northpole.security/docs.md)
- [Blog](https://northpole.security/blog.md)
- [Glossary](https://northpole.security/glossary.md)
- [About](https://northpole.security/about.md)
- [Contact](https://northpole.security/contact.md)