{"openapi":"3.0.3","info":{"title":"DayZ Hub Bot API","version":"1.1.0","description":"Read-only, owner-scoped data about your own Discord server. One token = one server. No endpoint writes or acts on members or the server. Members who opted out of data processing appear as anonymous. Limits follow the plan of the server: Premium 1: 2 active tokens and 60 requests per minute per token; Premium 2: 5 active tokens and 120 requests per minute per token; Premium 3: 10 active tokens and 300 requests per minute per token (a free trial or a sponsored server counts as Premium 1). Every answer carries an X-Request-Id header; errors are { ok: false, error, code, message, requestId }."},"servers":[{"url":"https://dayzhub.net/api/v1/bot"}],"tags":[{"name":"Bot API"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token created on /dashboard/<guildId>/bot-api. Scopes: guild:read (Server plan status and the list of features); giveaways:read (Giveaways (active and ended) with entry counts); tickets:read (Ticket counts by status and category (no ticket content)); leveling:read (Level leaderboard (opted-out members are anonymous)); shop:read (Public donation-shop products); suggestions:read (Suggestion counts by status); server-status:read (Public game-server status (only when publicly listed))"}},"schemas":{"Error":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string","description":"The stable error code (same value as code; kept for older clients)"},"code":{"type":"string","description":"Stable error code: bad_request, bad_cursor, unauthorized, invalid_token, guild_mismatch, origin_not_allowed, missing_scope, plan_required, feature_not_in_plan, not_found, shop_not_enabled, method_not_allowed, rate_limited, unavailable"},"message":{"type":"string","description":"Readable text; do not branch on it, use code"},"requestId":{"type":"string","description":"The X-Request-Id of this answer; quote it when you contact support"}},"required":["ok","error","code","message","requestId"],"additionalProperties":false},"Page":{"type":"object","properties":{"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"nextCursor":{"type":"string","nullable":true}},"required":["limit","hasMore","nextCursor"],"additionalProperties":false},"Member":{"type":"object","properties":{"id":{"type":"string","description":"Discord user id; null when the member opted out of data processing","nullable":true},"anonymous":{"type":"boolean"}},"required":["id","anonymous"],"additionalProperties":false},"Me":{"type":"object","properties":{"guildId":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"allowedOrigin":{"type":"string","nullable":true},"rateLimitPerMin":{"type":"integer","description":"Requests per minute this token may make right now (the plan rate, never lower than the token already had)"},"createdAt":{"type":"string","format":"date-time","nullable":true},"plan":{"type":"string","enum":["none","premium1","premium2","premium3"],"description":"The plan the limits come from; a free trial or a sponsored server counts as premium1"},"limits":{"type":"object","properties":{"tokens":{"type":"integer","description":"Active tokens this plan allows per server"},"perMinute":{"type":"integer","description":"Requests per minute per token on this plan"}},"required":["tokens","perMinute"],"additionalProperties":false},"tokensUsed":{"type":"integer","description":"Active (not revoked) tokens of this server"}},"required":["guildId","name","prefix","scopes","allowedOrigin","rateLimitPerMin","createdAt","plan","limits","tokensUsed"],"additionalProperties":false},"Guild":{"type":"object","properties":{"guildId":{"type":"string"},"name":{"type":"string"},"iconUrl":{"type":"string","nullable":true},"language":{"type":"string"},"plan":{"type":"object","properties":{"tier":{"type":"string","enum":["none","premium1","premium2","premium3","custom","main"]},"label":{"type":"string"},"status":{"type":"string","enum":["paid","trial","sponsored","none"]},"billingCycle":{"type":"string","enum":["monthly","annual"]},"trialEndsAt":{"type":"string","format":"date-time","nullable":true}},"required":["tier","label","status","billingCycle","trialEndsAt"],"additionalProperties":false}},"required":["guildId","name","iconUrl","language","plan"],"additionalProperties":false},"Feature":{"type":"object","properties":{"key":{"type":"string"},"tier":{"type":"string"},"includedInPlan":{"type":"boolean"},"enabled":{"type":"boolean","nullable":true}},"required":["key","tier","includedInPlan","enabled"],"additionalProperties":false},"Giveaway":{"type":"object","properties":{"id":{"type":"string"},"prize":{"type":"string"},"status":{"type":"string","enum":["active","ended"]},"type":{"type":"string","enum":["reaction","invite"]},"winnerCount":{"type":"integer"},"entryCount":{"type":"integer"},"endsAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"requirements":{"type":"object","properties":{"role":{"type":"boolean"},"verified":{"type":"boolean"},"minInvites":{"type":"integer"}},"required":["role","verified","minInvites"],"additionalProperties":false},"host":{"$ref":"#/components/schemas/Member"},"winners":{"type":"array","items":{"$ref":"#/components/schemas/Member"}}},"required":["id","prize","status","type","winnerCount","entryCount","endsAt","createdAt","requirements","host","winners"],"additionalProperties":false},"TicketSummary":{"type":"object","properties":{"open":{"type":"integer"},"closed":{"type":"integer"},"total":{"type":"integer"},"last30Days":{"type":"object","properties":{"created":{"type":"integer"},"closed":{"type":"integer"},"averageRating":{"type":"number","nullable":true},"ratingCount":{"type":"integer"},"averageFirstResponseMinutes":{"type":"number","nullable":true}},"required":["created","closed","averageRating","ratingCount","averageFirstResponseMinutes"],"additionalProperties":false},"byCategory":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"open":{"type":"integer"},"closed":{"type":"integer"}},"required":["category","open","closed"],"additionalProperties":false}}},"required":["open","closed","total","last30Days","byCategory"],"additionalProperties":false},"LevelEntry":{"type":"object","properties":{"rank":{"type":"integer"},"member":{"$ref":"#/components/schemas/Member"},"xp":{"type":"integer"},"level":{"type":"integer"}},"required":["rank","member","xp","level"],"additionalProperties":false},"ShopInfo":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string"}},"required":["name","description","slug","url"],"additionalProperties":false},"Product":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"description":{"type":"string"},"price":{"type":"number"},"compareAtPrice":{"type":"number","nullable":true},"currency":{"type":"string"},"type":{"type":"string","enum":["item","gift_card","subscription"]},"interval":{"type":"string","enum":["monthly","quarterly","yearly"],"nullable":true},"thumbnailUrl":{"type":"string","nullable":true},"featured":{"type":"boolean"},"inStock":{"type":"boolean"},"url":{"type":"string"}},"required":["id","name","slug","description","price","compareAtPrice","currency","type","interval","thumbnailUrl","featured","inStock","url"],"additionalProperties":false},"SuggestionSummary":{"type":"object","properties":{"total":{"type":"integer"},"byStatus":{"type":"object","properties":{"pending":{"type":"integer"},"approved":{"type":"integer"},"denied":{"type":"integer"}},"required":["pending","approved","denied"],"additionalProperties":false},"votes":{"type":"object","properties":{"up":{"type":"integer"},"down":{"type":"integer"}},"required":["up","down"],"additionalProperties":false},"last30Days":{"type":"object","properties":{"created":{"type":"integer"}},"required":["created"],"additionalProperties":false}},"required":["total","byStatus","votes","last30Days"],"additionalProperties":false},"ServerStatus":{"type":"object","properties":{"listed":{"type":"boolean"},"servers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string"},"online":{"type":"boolean","nullable":true},"players":{"type":"integer","nullable":true},"maxPlayers":{"type":"integer","nullable":true},"address":{"type":"string","nullable":true},"lastChangeAt":{"type":"string","format":"date-time","nullable":true}},"required":["name","slug","url","online","players","maxPlayers","address","lastChangeAt"],"additionalProperties":false}}},"required":["listed","servers"],"additionalProperties":false}}},"paths":{"/me":{"get":{"summary":"The token itself, its plan and limits (no plan check)","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/Me"}},"required":["ok","data"]}}}},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}":{"get":{"summary":"Plan status of the server","security":[{"bearerAuth":["guild:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/Guild"}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}/features":{"get":{"summary":"Features, tier and on/off state","security":[{"bearerAuth":["guild:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Feature"}}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}/giveaways":{"get":{"summary":"Giveaways with entry counts","security":[{"bearerAuth":["giveaways:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."},{"name":"status","in":"query","schema":{"type":"string","enum":["active","ended","all"],"default":"all"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Opaque; use page.nextCursor from the previous answer."}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Giveaway"}},"page":{"$ref":"#/components/schemas/Page"},"privacy":{"type":"string","enum":["ok","degraded"],"description":"degraded: the opt-out lookup failed, every member on the page is anonymous"}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}/giveaways/{id}":{"get":{"summary":"One giveaway","security":[{"bearerAuth":["giveaways:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."},{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{24}$"}}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/Giveaway"},"privacy":{"type":"string","enum":["ok","degraded"],"description":"degraded: the opt-out lookup failed, every member on the page is anonymous"}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No such giveaway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}/tickets/summary":{"get":{"summary":"Ticket counts (no ticket content)","security":[{"bearerAuth":["tickets:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/TicketSummary"}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}/leaderboard/levels":{"get":{"summary":"Level leaderboard (top 1000 at most)","security":[{"bearerAuth":["leveling:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Opaque; use page.nextCursor from the previous answer."}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LevelEntry"}},"total":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page"},"privacy":{"type":"string","enum":["ok","degraded"],"description":"degraded: the opt-out lookup failed, every member on the page is anonymous"}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}/shop/products":{"get":{"summary":"Public donation-shop products","security":[{"bearerAuth":["shop:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Opaque; use page.nextCursor from the previous answer."}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"shop":{"$ref":"#/components/schemas/ShopInfo"},"page":{"$ref":"#/components/schemas/Page"}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The server has no public shop","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}/suggestions/summary":{"get":{"summary":"Suggestion counts (no suggestion text)","security":[{"bearerAuth":["suggestions:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/SuggestionSummary"}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/guilds/{guildId}/server-status":{"get":{"summary":"Public game-server status (listed servers only)","security":[{"bearerAuth":["server-status:read"]}],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]{17,20}$"},"description":"Must be the guild of the token."}],"responses":{"200":{"description":"OK","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"},"description":"Id of this request; a safe X-Request-Id you send is kept"},"Cache-Control":{"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/ServerStatus"}},"required":["ok","data"]}}}},"304":{"description":"Not modified (If-None-Match matched)"},"401":{"description":"Missing, malformed, unknown or revoked token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Wrong guild, missing scope, origin not allowed, plan required or feature not in plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; see Retry-After","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable (the API fails closed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}