Delete Dynamic Config Rule

deletehttps://statsigapi.net/console/v1/dynamic_configs/{id}/rule/{ruleId}

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

Dynamic Config ID

ruleIdstringrequired

Rule ID

Response

application/json
200· Delete Dynamic Config Rule Response
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
Show child attributes
idstringrequired

ID

namestring

Optional name for the configuration.

idTypestring

The type of ID which the dynamic config is based on.

descriptionstringrequired

A brief summary of what the dynamic config is being used for

lastModifierIDstringrequired

ID of the last modifier.

lastModifiedTimenumberrequired

Time of the last modification.

lastModifierEmailstringrequired

Email of the last modifier.

lastModifierNamestringrequired

Name of the last modifier.

creatorIDstring
createdTimenumberrequired

Timestamp when the entity was created.

creatorNamestringrequired

Name of the creator.

creatorEmailstring
tagsstring[]

The list of tag names attached to the dynamic config

targetAppsoneOf
holdoutIDsstring[]

Holdouts applied to this configuration.

teamstring

The team name associated with the dynamic config, Enterprise only.

teamIDstring

The team ID associated with the dynamic config, Enterprise only.

versionnumber

Version number

isEnabledbooleanrequired

Is the dynamic config enabled

rulesobject[]required

An array of Rule objects

name[]stringrequired

The name of this rule.

passPercentage[]numberrequired

Of the users that meet the conditions of this rule, what percent should return true.

conditions[]object[]required

An array of Condition objects.

targetValue[]oneOf
operator[]string
field[]string
customID[]string
type[]stringrequired
environments[]string[]
id[]string

The Statsig ID of this rule.

baseID[]string

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

returnValue[]object
completedAutomatedRollouts[]object[]

Read-only: Automated rollout phases that have already completed.

time[]number
passPercent[]numberrequired
pendingAutomatedRollouts[]object[]

Read-only: Automated rollout phases that are scheduled but not yet complete.

time[]number
passPercent[]numberrequired
returnValueJson5[]string
variants[]object[]
id[]string
name[]stringrequired
passPercentage[]numberrequired
returnValue[]object
returnValueJson5[]string
defaultValueobject

The fallback JSON object when no rules are triggered

defaultValueJson5string

Can include comments. If provided with defaultValue, must parse to the same JSON

ownerobject

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

ownerIDstring

ID of the owner

ownerTypestring

Type of the owner (e.g., SDK_KEY or USER)

ownerNamestring

The name of the owner. This field is optional.

ownerEmailstring

The email of the owner. This field is optional.

schemastring

A schema using JSON Schema Draft 2020-12 to enforce return values of this dynamic config's rules.

schemaJson5string

schema except with Json5 comments. Optional and should parse to same json as schema.

releasePipelineIDstring

The release pipeline ID associated with the dynamic config

isTemplateboolean
statusstring
checksPerHournumber
permalinkstringrequired

A permalink to this dynamic config in the Statsig Console.

typestringrequired

The lifecycle type of the config (TEMPORARY, PERMANENT, or STALE). STALE classification depends on the nightly stale detection batch job having run; a config not yet processed reads as TEMPORARY.

typeReasonstringrequired

The reason for the current type classification. Depends on the nightly stale detection batch job having run.

isPermanentbooleanrequired

Whether the config has been explicitly marked as long-lived.

Was this helpful?