# Stardraw Cloud Admin API

Every operation in the Stardraw Cloud Admin API, one line each — 142 operations across 9 resources. Follow a resource link for parameters, request bodies and responses; [schemas.md](schemas.md) has the object definitions.

The machine-readable OpenAPI document is at https://stardraw.cloud/api/v1/admin/openapi.yaml (admin API).

Base URL: `https://stardraw.cloud/api/v1/admin/`  
Authentication: `Authorization: Bearer <token>` on every request — see https://stardraw.cloud/developer/authentication  
Conventions (soft deletes, `version` on every PATCH, grid queries): https://stardraw.cloud/developer/conventions

---

## Application configuration

Full reference: [application.md](application.md)

- `GET /application` — Get application
- `PUT /applications/{applicationId}` — Update application
- `PATCH /applications/{applicationId}` — Patch application
- `GET /emails` — Get emails
- `POST /emails` — Create email
- `GET /emails/{emailId}` — Get email
- `PUT /emails/{emailId}` — Update email
- `PATCH /emails/{emailId}` — Patch email
- `DELETE /emails/{emailId}` — Delete email
- `POST /emails/preview` — Preview email
- `POST /emails/sendtest` — Send test email
- `GET /lists` — Get application lists
- `POST /lists` — Create application list
- `PUT /lists/{listId}` — Update application list
- `PATCH /lists/{listId}` — Patch application list
- `DELETE /lists/{listId}` — Delete application list
- `GET /lists/{listId}/items` — Get application list items
- `POST /lists/{listId}/items` — Add application list item
- `PUT /lists/{listId}/items/{itemId}` — Update application list item
- `PATCH /lists/{listId}/items/{itemId}` — Patch application list item
- `DELETE /lists/{listId}/items/{itemId}` — Delete application list item
- `POST /logs` — Get logs with server-side grid query
- `GET /mcp` — Get MCP/assistant settings
- `PATCH /mcp` — Patch MCP/assistant settings
- `GET /mcp/voices` — List ElevenLabs voices
- `POST /mcplog/grid` — Get MCP tool-usage log with server-side grid query
- `GET /stardrawviews` — Get view templates
- `GET /translations` — Get translations
- `POST /translations` — Create translation
- `PUT /translations` — Batch upsert translations
- `GET /translations/{id}` — Get translation by ID
- `PUT /translations/{id}` — Update translation
- `PATCH /translations/{id}` — Patch translation
- `DELETE /translations/{id}` — Delete translation
- `POST /translations/translate` — Translate sentences
- `GET /webhooks` — List webhook endpoints
- `POST /webhooks` — Create webhook endpoint
- `GET /webhooks/{id}` — Get webhook endpoint
- `PATCH /webhooks/{id}` — Patch webhook endpoint
- `GET /webhooks/{id}/secret` — Reveal webhook signing secret
- `POST /webhooks/{id}/secret/roll` — Roll webhook signing secret
- `POST /webhooks/{id}/test` — Send a test event
- `GET /webhooks/deliveries/{id}` — Get webhook delivery
- `POST /webhooks/deliveries/{id}/resend` — Resend a webhook delivery
- `POST /webhooks/deliveries/grid` — Get webhook deliveries with server-side grid query
- `GET /webhooks/event-types` — List webhook event types

## Catalog: products, cables, connectors and signals

Full reference: [catalog.md](catalog.md)

- `POST /cables` — Create cable
- `PUT /cables/{cableId}` — Update cable
- `PATCH /cables/{cableId}` — Patch cable
- `DELETE /cables/{cableId}` — Delete cable
- `POST /cables/grid` — Get cables with server-side grid query
- `GET /cablesettings` — Get cable settings
- `PATCH /cablesettings` — Patch cable settings
- `POST /connectorpairings` — Create connector pairing
- `PUT /connectorpairings/{pairingId}` — Update connector pairing
- `PATCH /connectorpairings/{pairingId}` — Patch connector pairing
- `DELETE /connectorpairings/{pairingId}` — Delete connector pairing
- `POST /connectorpairings/grid` — Get connector pairings with server-side grid query
- `POST /connectors` — Create connector
- `PUT /connectors/{connectorId}` — Update connector
- `PATCH /connectors/{connectorId}` — Patch connector
- `DELETE /connectors/{connectorId}` — Delete connector
- `POST /connectors/grid` — Get connectors with server-side grid query
- `POST /signals` — Create signal
- `PUT /signals/{signalId}` — Update signal
- `PATCH /signals/{signalId}` — Patch signal
- `DELETE /signals/{signalId}` — Delete signal
- `POST /signals/grid` — Get signals with server-side grid query

## Files

Full reference: [files.md](files.md)

- `POST /files` — Create application file
- `PUT /files/{fileId}` — Update application file
- `DELETE /files/{fileId}` — Delete application file
- `POST /files/grid` — Get application files with server-side grid query
- `POST /files/upload` — Get URL for file upload

## Products

Full reference: [products.md](products.md)

- `GET /products` — Get application products
- `POST /products` — Create application product
- `GET /products/{productId}` — Get application product
- `PUT /products/{productId}` — Update application product
- `PATCH /products/{productId}` — Partially update application product
- `DELETE /products/{productId}` — Delete application product
- `POST /products/audit` — Audit the product catalog's data hygiene
- `POST /products/changes` — Recent catalog product changes, newest first
- `POST /products/compare` — Compare application products
- `POST /products/grid` — Get products with server-side grid query
- `GET /products/reindex` — Get product reindex progress
- `POST /products/reindex` — Reindex application product embeddings
- `POST /products/reindex/cancel` — Cancel a product reindex
- `POST /products/updateproducts` — Push catalog settings and symbols into existing projects
- `POST /products/usage` — Which projects contain the given catalog products

## Projects

Full reference: [projects.md](projects.md)

- `PUT /projects/{projectId}` — Update a project
- `PATCH /projects/{projectId}` — Patch a project
- `DELETE /projects/{projectId}` — Delete a project
- `POST /projects/grid` — Get projects with server-side grid query

## Reports

Full reference: [reports.md](reports.md)

- `GET /reports` — Get reports
- `POST /reports` — Create report
- `PUT /reports/{reportId}` — Update report
- `PATCH /reports/{reportId}` — Patch report
- `DELETE /reports/{reportId}` — Delete report
- `POST /reports/grid` — Get reports with server-side grid query

## Session recordings

Full reference: [session-recordings.md](session-recordings.md)

- `GET /sessionrecordings/{id}` — Get session recording metadata
- `DELETE /sessionrecordings/{id}` — Delete a session recording
- `POST /sessionrecordings/{id}/sas` — Get read-only SAS for a session recording blob
- `POST /sessionrecordings/grid` — Get session recordings with server-side grid query

## Users, authentication and access

Full reference: [users-and-access.md](users-and-access.md)

- `GET /domains` — Get domains
- `POST /domains` — Create domain
- `DELETE /domains` — Delete domain
- `POST /domains/refresh` — Refresh domain validation token
- `POST /oauth/token` — Obtain OAuth token
- `GET /oAuth2Providers` — List SSO providers
- `POST /oAuth2Providers` — Create SSO provider
- `GET /oAuth2Providers/{id}` — Get SSO provider details
- `PUT /oAuth2Providers/{id}` — Update SSO provider
- `PATCH /oAuth2Providers/{id}` — Patch SSO provider
- `POST /oAuth2Providers/{id}/generateappleclientsecret` — Generate Apple client secret
- `GET /oAuth2Providers/discover` — Discover OIDC configuration
- `POST /oAuth2Providers/register` — Register this application as a client of an OIDC provider
- `GET /oauthClients` — List OAuth clients
- `POST /oauthClients` — Create OAuth client
- `GET /oauthClients/{id}` — Get OAuth client
- `PUT /oauthClients/{id}` — Update OAuth client
- `PATCH /oauthClients/{id}` — Patch OAuth client
- `POST /roles` — Create role
- `PUT /roles/{roleId}` — Update role
- `PATCH /roles/{roleId}` — Patch role
- `DELETE /roles/{roleId}` — Delete role
- `POST /roles/grid` — Get roles with server-side grid query
- `POST /user/login` — Impersonate a user
- `GET /users/{userId}` — Get user
- `PUT /users/{userId}` — Update user
- `DELETE /users/{userId}` — Delete user
- `POST /users/{userId}/projects/grid` — Get user projects with server-side grid query
- `POST /users/grid` — Get users with server-side grid query

## View templates

Full reference: [views.md](views.md)

- `GET /views` — Get application views
- `POST /views` — Create application view from a full body
- `PUT /views/{viewId}` — Update application view
- `PATCH /views/{viewId}` — Patch application view
- `DELETE /views/{viewId}` — Delete (hide) application view
- `POST /views/{viewId}/files` — Create application view file
- `GET /views/{viewId}/files/{fileId}` — Get application view file
- `PUT /views/{viewId}/files/{fileId}` — Update application view file
- `DELETE /views/{viewId}/files/{fileId}` — Delete application view file
- `POST /views/{viewId}/files/grid` — Get application view files with server-side grid query
- `POST /views/from-template` — Create application view from a template