Skip to main content

​
Platform status

Deck publishes real-time operational status at status.deck.co. Subscribe to receive notifications about downtime, degraded performance, and scheduled maintenance.

​
Versioning

Deck uses semantic versioning (e.g., v1.6, v2.2, v3) to manage breaking changes. Each version defines how Deck interprets requests, structures responses, and delivers events. Every team has a default API version that applies to all API keys and event deliveries. New teams start on the latest stable version automatically.

​
Breaking changes

Deck only releases new API versions when changes would break existing integrations. Breaking changes include:
  • Removing or renaming fields
  • Changing response structures or data types
  • Modifying required parameters
  • Altering authentication or error formats
  • Backwards-incompatible changes to endpoint behavior
  • Removing endpoints
Deck provides advance notice before releasing breaking changes, announced in the changelog with migration notes.

​
Additive changes

Deck continuously ships additive, non-breaking updates that improve the API without requiring a new version. These roll out automatically to all supported versions. Examples include:
  • New optional request parameters
  • New response fields
  • New endpoints or resources
  • New event types
  • New optional HTTP headers
  • Changes to the order of properties in responses
  • Changes to the length or format of object IDs (up to 255 characters)
  • Bug fixes that improve correctness
Your integration should handle additive changes gracefully. Ignore fields you don’t recognize, don’t fail on unexpected enum values, and handle unfamiliar event types in your event handlers.

​
Building resilient integrations

  • Subscribe to the status page for incident notifications
  • Handle unknown fields and enum values without failing
  • Use the request_id on error responses when contacting support
  • Use events instead of polling to reduce your dependency on API availability