Skip to main content

Availability and Deployment Gates

Several features are controlled by deployment gates. A gate that is off means the routes can appear in the OpenAPI reference while the deployment refuses new work for that feature. Documentation and automated tests describe the product; they do not show that a particular deployment, its workers, its network and its model providers behave as described. Your installation operator decides when a gate is enabled.

Gates​

FeatureDeployment settingDefaultDocumentation
Service credentialsAPI_SERVICE_CREDENTIALS_ENABLED, plus Organization enablementOffService credentials
Application requestsAPI_APPLICATION_REQUESTS_ENABLEDOffApplication requests
Typed resultsAPI_STRUCTURED_RESULTS_ENABLED (also requires application requests)OffStructured data
REST file upload and replacementAPI_REST_FILES_ENABLEDOffREST files
Named schedules and setup writesAPI_CONFIGURATION_ENABLEDOffConfiguration and schedules
Usage and audit metadata readsAPI_OPERATIONAL_READS_ENABLEDOffUsage and audit
Automatic agent eventsAPI_AUTOMATIC_AGENT_EVENTS_ENABLEDOffWebhooks
Extended retry coverage for Idempotency-KeyAPI_EXTENDED_RETRIES_ENABLEDOffIdempotency
Shared request quotasAPI_ADMISSION_ENABLEDOptionalLimits and compatibility
External security responseCUSTOMER_SECURITY_HALT_ENABLED and Organization scopeGatedExternal security halt

A feature page states which reads and retained retries, if any, stay available when its gate is switched off. Where a page does not say, assume none do.

Before you enable a gate​

  1. Read the feature page and apply the migrations and process upgrades it names. Drain older writers and readers where the page says to.
  2. Enable the gate in a non-production environment that uses the same workers, storage, network policy and model providers as production.
  3. Exercise the feature end to end, including the failure and rollback paths the page describes. A passing unit test or a reachable route does not show that your workers and providers cooperate.
  4. Enable it for production deliberately, one Organization at a time where the feature supports that.

To roll back, disable the gate. Retained readers, replay and recovery keep running as each feature page describes.

What a gate does not promise​

  • Enabling a gate does not establish throughput, availability or latency. Measure those in your environment.
  • Containment features, including External security halt, report what they could confirm. A closed connection or a recorded time never proves that the other side stopped.
  • Provider-specific behavior, such as a model provider's streaming or a SIEM's indexing, depends on that provider's configuration.