status-docs

Shardwright Connect

Public REST API status. Base URL: /api/v1. Scoped API key issuance is owned by Identity.Api.

GET /api/v1/guilds List guilds the API key can access.
GET /api/v1/guilds/{guildId} Get a single guild.
GET /api/v1/guilds/{guildId}/config Read guild config.
PUT /api/v1/guilds/{guildId}/config Replace guild config.
POST /api/v1/guilds/{guildId}/moderation/cases Create a moderation case.
GET /api/v1/guilds/{guildId}/moderation/cases List moderation cases.
POST /api/v1/guilds/{guildId}/announcements Send a guild announcement.
POST /api/v1/guilds/{guildId}/scheduler/jobs Schedule a job.
GET /api/v1/guilds/{guildId}/scheduler/jobs List scheduled jobs.
GET /api/v1/guilds/{guildId}/audit-log Read audit log entries.
GET /api/v1/guilds/{guildId}/webhook-deliveries List webhook deliveries.

Authentication

External requests require a scoped guild credential. Portal-created keys are shown once, then only safe metadata remains visible.

X-Shardwright-Api-Key: <issued-key-shown-once>
X-Shardwright-Correlation-Id: 5b9a...
X-Shardwright-Idempotency-Key: 01HZ...

Example: create moderation case

POST /api/guilds/{guildId}/moderation/warnings
Content-Type: application/json