Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Pass your API key as the Bearer token. See Authentication.

Path Parameters

id
string
required

The id of the requested resource

Body

application/json
name
string

Short display name, usually app and platform (e.g. Web app).

language
string
sdkVersion
string
environment
string
projects
string[]
encryptPayload
boolean
includeVisualExperiments
boolean
includeDraftExperiments
boolean
includeDraftExperimentRefs
boolean

When true, experiment-ref rules linked to draft experiments are included in feature definitions. Off by default.

includeExperimentNames
boolean
includeRedirectExperiments
boolean
includeRuleIds
boolean
includeProjectIdInMetadata
boolean
includeCustomFieldsInMetadata
boolean
allowedCustomFieldsInMetadata
string[]
includeTagsInMetadata
boolean
includeExperimentScheduleInMetadata
boolean
tracesEnabled
boolean

Send SDK evaluation traces to GrowthBook. Only available to organizations with tracing enabled.

proxyEnabled
boolean
proxyHost
string
hashSecureAttributes
boolean
remoteEvalEnabled
boolean
savedGroupReferencesEnabled
boolean

Deprecated. Use savedGroupFormat.

savedGroupFormat
enum<string>
Available options:
inline,
referencesV1,
referencesV2
includeReferencedPrerequisites
boolean

Carry prerequisite Feature Flags into this payload even when they target other Projects. Defaults to true for new connections.

archived
boolean

Archive (true) or restore (false) the connection. Archiving takes the same authority as deleting it; restoring takes publish authority.

bypassApproval
boolean

Set to true to write directly to the live SDK Connection without approval. The caller must have Bypass draft approvals access in the SDK Connection's Projects, unless the organization enables the REST API approval bypass. This field has no effect when approval is not required.

ignoreWarnings
boolean

Set to true to continue past a warning: one raised by a Custom Hook, or a webhook that references a secret that doesn't exist. On publish, it also force-publishes an out-of-date draft when the caller has Bypass draft approvals access. It never clears a Custom Hook rejection. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.

skipHooks
boolean

Set to true to continue despite a Custom Hook rejection. The caller must have Bypass draft approvals access for SDK Connections in every Project. Otherwise, this field is ignored. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.

Response

Resource updated

sdkConnection
object
required
bypassedGates
object[]

Gates that would have blocked this publish but were bypassed by the caller's authority. Present only when at least one gate was bypassed.