# Outpost API

Create an Outpost key in Settings. The secret is shown once. Send it in the Authorization header on each /v1 call. A read key opens the environment, its listeners, caught events, and the catalog. A manage key changes listeners and automations, edits a definition, and replays an event. An agency admin can create a key for every environment. Register the listener URL in Bluestone PIM. Bluestone signs that call with the listener secret.

## Operations

- POST /v1/accounts/admins: Invite an agency admin
- DELETE /v1/actions/{id}: Delete an automation
- PATCH /v1/actions/{id}: Edit an automation
- POST /v1/actions/{id}/pause: Pause an automation
- GET /v1/environments/{id}: Read an environment
- GET /v1/environments/{id}/assignees: List assignees
- POST /v1/environments/{id}/check: Check stored API keys
- POST /v1/environments/{id}/connect: Save API keys
- GET /v1/environments/{id}/definitions: List definitions
- POST /v1/environments/{id}/listeners: Create a listener
- GET /v1/environments/{id}/studio/attributes: Read the attribute catalog
- GET /v1/environments/{id}/studio/cla: Read category attributes
- POST /v1/environments/{id}/studio/delete: Remove category attributes
- POST /v1/environments/{id}/studio/edit: Edit a definition cell
- GET /v1/environments/{id}/studio/map: Read the saved map
- GET /v1/environments/{id}/studio/map/categories/{categoryId}: List products in a category
- POST /v1/environments/{id}/studio/map/refresh: Refresh the map
- POST /v1/environments/{id}/studio/move: Move a definition
- GET /v1/environments/{id}/studio/products: Read product assignments
- POST /v1/events/{id}/replay: Replay an event
- POST /v1/invites: Send an invite
- POST /v1/invites/{id}/revoke: Revoke an invite
- GET /v1/keys: List keys
- POST /v1/keys: Create a key
- DELETE /v1/keys/{id}: Revoke a key
- DELETE /v1/listeners/{id}: Delete a listener
- PATCH /v1/listeners/{id}: Rename a listener
- POST /v1/listeners/{id}/actions: Create an automation
- GET /v1/listeners/{id}/deliveries: List caught events
- GET /v1/listeners/{id}/deliveries/{eventId}: Read one caught event
- POST /v1/listeners/{id}/events/clear: Clear the event list
- POST /v1/listeners/{id}/labels: Fetch product names
- PATCH /v1/listeners/{id}/monitor: Fetch names on ingress
- POST /v1/listeners/{id}/pause: Pause a listener
- POST /v1/organisations: Add an organisation
- DELETE /v1/organisations/{id}: Remove an organisation
- POST /v1/organisations/{id}/environments: Add an environment

The OpenAPI file is /docs/openapi.yaml.