v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-102991198.1 KB
Configuration

Update Managed Configuration

Updates one or more managed Outpost configuration values. Null values clear the configuration and reverts to Outpost default behavior.

This endpoint is only available for the managed version. In self-hosted deployments, configuration is controlled through environment variables instead.

Only the supported configuration keys are accepted.

patch/config

Request body

ALERT_AUTO_DISABLE_DESTINATIONstring

If "true", automatically disables a destination once ALERT_CONSECUTIVE_FAILURE_COUNT is reached. Has no effect when consecutive-failure alerting is disabled.

ALERT_CONSECUTIVE_FAILURE_COUNTstring

Consecutive delivery failures before alerting on a destination (and disabling it when ALERT_AUTO_DISABLE_DESTINATION is "true"). Omit for the default of 100; set to an empty string to disable consecutive-failure alerting entirely.

ALERT_EXHAUSTED_RETRIES_WINDOW_SECONDSstring

Suppression window in seconds for exhausted_retries alerts: the first exhaustion per destination alerts and subsequent ones within the window are suppressed ("0" = no suppression). Omit for the default of 3600; set to an empty string to disable exhausted_retries alerting entirely.

DELIVERY_TIMEOUT_SECONDSstring
DESTINATIONS_AWS_KINESIS_METADATA_IN_PAYLOADstring
DESTINATIONS_INCLUDE_MILLISECOND_TIMESTAMPstring
DESTINATIONS_WEBHOOK_EVENT_ID_HEADER_NAMEstring

Complete name of the event ID header. Unset uses the default "<prefix>event-id"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_HEADER_PREFIXstring
DESTINATIONS_WEBHOOK_MODEstring
DESTINATIONS_WEBHOOK_PROXY_URLstring
DESTINATIONS_WEBHOOK_SIGNATURE_ALGORITHMstring
DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATEstring
DESTINATIONS_WEBHOOK_SIGNATURE_ENCODINGstring
DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_NAMEstring

Complete name of the signature header. Unset uses the default "<prefix>signature"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATEstring
DESTINATIONS_WEBHOOK_SIGNING_SECRET_TEMPLATEstring
DESTINATIONS_WEBHOOK_TIMESTAMP_HEADER_NAMEstring

Complete name of the timestamp header. Unset uses the default "<prefix>timestamp"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_TOPIC_HEADER_NAMEstring

Complete name of the topic header. Unset uses the default "<prefix>topic"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

HTTP_USER_AGENTstring
IDGEN_ATTEMPT_PREFIXstring
IDGEN_DESTINATION_PREFIXstring
IDGEN_EVENT_PREFIXstring
IDGEN_TYPEstring
MAX_DESTINATIONS_PER_TENANTstring
PORTAL_BRAND_COLORstring
PORTAL_DISABLE_OUTPOST_BRANDINGstring
PORTAL_FAVICON_URLstring
PORTAL_FORCE_THEMEstring
PORTAL_LOGOstring
PORTAL_LOGO_DARKstring
PORTAL_ORGANIZATION_NAMEstring
PORTAL_REFERER_URLstring
PORTAL_REFRESH_URLstring
PORTAL_ENABLE_DESTINATION_FILTERstring
PORTAL_ENABLE_WEBHOOK_CUSTOM_HEADERSstring
RETRY_INTERVAL_SECONDSstring
MAX_RETRY_LIMITstring
RETRY_SCHEDULEstring
OTEL_EXPORTER_OTLP_ENDPOINTstring
OTEL_EXPORTER_OTLP_HEADERSstring
OTEL_EXPORTER_OTLP_PROTOCOLstring
OTEL_EXPORTER_OTLP_TRACES_ENDPOINTstring
OTEL_EXPORTER_OTLP_METRICS_ENDPOINTstring
OTEL_EXPORTER_OTLP_LOGS_ENDPOINTstring
OTEL_SERVICE_NAMEstring
PUBLISH_AWS_SQS_ACCESS_KEY_IDstring
PUBLISH_AWS_SQS_ENDPOINTstring
PUBLISH_AWS_SQS_QUEUEstring
PUBLISH_AWS_SQS_REGIONstring
PUBLISH_AWS_SQS_SECRET_ACCESS_KEYstring
PUBLISH_AZURE_SERVICEBUS_CONNECTION_STRINGstring
PUBLISH_AZURE_SERVICEBUS_SUBSCRIPTIONstring
PUBLISH_AZURE_SERVICEBUS_TOPICstring
PUBLISH_GCP_PUBSUB_PROJECTstring
PUBLISH_GCP_PUBSUB_SERVICE_ACCOUNT_CREDENTIALSstring
PUBLISH_GCP_PUBSUB_SUBSCRIPTIONstring
PUBLISH_GCP_PUBSUB_TOPICstring
PUBLISH_RABBITMQ_EXCHANGEstring
PUBLISH_RABBITMQ_QUEUEstring
PUBLISH_RABBITMQ_SERVER_URLstring
TOPICSstring
TOPICS_ALLOW_WILDCARDSstring

Example request

{
  "TOPICS": "user.created,user.updated",
  "DESTINATIONS_WEBHOOK_MODE": "default"
}

Response

Updated managed configuration.

ALERT_AUTO_DISABLE_DESTINATIONstring

If "true", automatically disables a destination once ALERT_CONSECUTIVE_FAILURE_COUNT is reached. Has no effect when consecutive-failure alerting is disabled.

ALERT_CONSECUTIVE_FAILURE_COUNTstring

Consecutive delivery failures before alerting on a destination (and disabling it when ALERT_AUTO_DISABLE_DESTINATION is "true"). Omit for the default of 100; set to an empty string to disable consecutive-failure alerting entirely.

ALERT_EXHAUSTED_RETRIES_WINDOW_SECONDSstring

Suppression window in seconds for exhausted_retries alerts: the first exhaustion per destination alerts and subsequent ones within the window are suppressed ("0" = no suppression). Omit for the default of 3600; set to an empty string to disable exhausted_retries alerting entirely.

DELIVERY_TIMEOUT_SECONDSstring
DESTINATIONS_AWS_KINESIS_METADATA_IN_PAYLOADstring
DESTINATIONS_INCLUDE_MILLISECOND_TIMESTAMPstring
DESTINATIONS_WEBHOOK_EVENT_ID_HEADER_NAMEstring

Complete name of the event ID header. Unset uses the default "<prefix>event-id"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_HEADER_PREFIXstring
DESTINATIONS_WEBHOOK_MODEstring
DESTINATIONS_WEBHOOK_PROXY_URLstring
DESTINATIONS_WEBHOOK_SIGNATURE_ALGORITHMstring
DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATEstring
DESTINATIONS_WEBHOOK_SIGNATURE_ENCODINGstring
DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_NAMEstring

Complete name of the signature header. Unset uses the default "<prefix>signature"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATEstring
DESTINATIONS_WEBHOOK_SIGNING_SECRET_TEMPLATEstring
DESTINATIONS_WEBHOOK_TIMESTAMP_HEADER_NAMEstring

Complete name of the timestamp header. Unset uses the default "<prefix>timestamp"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_TOPIC_HEADER_NAMEstring

Complete name of the topic header. Unset uses the default "<prefix>topic"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

HTTP_USER_AGENTstring
IDGEN_ATTEMPT_PREFIXstring
IDGEN_DESTINATION_PREFIXstring
IDGEN_EVENT_PREFIXstring
IDGEN_TYPEstring
MAX_DESTINATIONS_PER_TENANTstring
PORTAL_BRAND_COLORstring
PORTAL_DISABLE_OUTPOST_BRANDINGstring
PORTAL_FAVICON_URLstring
PORTAL_FORCE_THEMEstring
PORTAL_LOGOstring
PORTAL_LOGO_DARKstring
PORTAL_ORGANIZATION_NAMEstring
PORTAL_REFERER_URLstring
PORTAL_REFRESH_URLstring
PORTAL_ENABLE_DESTINATION_FILTERstring
PORTAL_ENABLE_WEBHOOK_CUSTOM_HEADERSstring
RETRY_INTERVAL_SECONDSstring
MAX_RETRY_LIMITstring
RETRY_SCHEDULEstring
OTEL_EXPORTER_OTLP_ENDPOINTstring
OTEL_EXPORTER_OTLP_HEADERSstring
OTEL_EXPORTER_OTLP_PROTOCOLstring
OTEL_EXPORTER_OTLP_TRACES_ENDPOINTstring
OTEL_EXPORTER_OTLP_METRICS_ENDPOINTstring
OTEL_EXPORTER_OTLP_LOGS_ENDPOINTstring
OTEL_SERVICE_NAMEstring
PUBLISH_AWS_SQS_ACCESS_KEY_IDstring
PUBLISH_AWS_SQS_ENDPOINTstring
PUBLISH_AWS_SQS_QUEUEstring
PUBLISH_AWS_SQS_REGIONstring
PUBLISH_AWS_SQS_SECRET_ACCESS_KEYstring
PUBLISH_AZURE_SERVICEBUS_CONNECTION_STRINGstring
PUBLISH_AZURE_SERVICEBUS_SUBSCRIPTIONstring
PUBLISH_AZURE_SERVICEBUS_TOPICstring
PUBLISH_GCP_PUBSUB_PROJECTstring
PUBLISH_GCP_PUBSUB_SERVICE_ACCOUNT_CREDENTIALSstring
PUBLISH_GCP_PUBSUB_SUBSCRIPTIONstring
PUBLISH_GCP_PUBSUB_TOPICstring
PUBLISH_RABBITMQ_EXCHANGEstring
PUBLISH_RABBITMQ_QUEUEstring
PUBLISH_RABBITMQ_SERVER_URLstring
TOPICSstring
TOPICS_ALLOW_WILDCARDSstring

Example response

{
  "TOPICS": "user.created,user.updated",
  "DESTINATIONS_WEBHOOK_MODE": "default"
}