Delete Dynamic Config Rule

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.

Example:my_config
Constraints:min length: 3max length: 100pattern: ^[a-zA-Z0-9_\-. ]*$
idTypestring

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

Example:userID
descriptionstringrequired

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

Example:helpful summary of what this dynamic config does
Constraints:max length: 1000
lastModifierIDstringrequired

ID of the last modifier.

Constraints:nullable
lastModifiedTimenumberrequired

Time of the last modification.

Constraints:format: doublenullable
lastModifierEmailstringrequired

Email of the last modifier.

Constraints:nullable
lastModifierNamestringrequired

Name of the last modifier.

Constraints:nullable
creatorIDstring
Constraints:nullable
createdTimenumberrequired

Timestamp when the entity was created.

Constraints:format: double
creatorNamestringrequired

Name of the creator.

Constraints:nullable
creatorEmailstring
Constraints:nullable
tagsstring[]

The list of tag names attached to the dynamic config

Example:["a tag"]
targetAppsoneOf
Constraints:stringstring[]
holdoutIDsstring[]

Holdouts applied to this configuration.

teamstring

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

Constraints:nullable
teamIDstring

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

Constraints:nullable
versionnumber

Version number

Constraints:format: double
isEnabledbooleanrequired

Is the dynamic config enabled

Default:true
rulesobject[]required

An array of Rule objects

namestringrequired

The name of this rule.

passPercentagenumberrequired

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

Constraints:min: 0max: 100
conditionsobject[]required

An array of Condition objects.

targetValueoneOf
Constraints:nullablestring[]number[]stringnumber
operatorstring
fieldstring
Constraints:nullable
customIDstring
Constraints:nullable
typestringrequired
Allowed values:app_versionbrowser_namebrowser_versioncountrycustom_fieldemailenvironment_tierfails_gatefails_segmentip_addresslocaleos_nameos_versionpasses_gatepasses_segmentpublictimeunit_iduser_iduser_agenturljavascriptdevice_modeltarget_appexperiment_group
environmentsstring[]
Constraints:nullable
idstring

The Statsig ID of this rule.

baseIDstring

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

returnValueobject
completedAutomatedRolloutsobject[]

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

timenumber
passPercentnumberrequired
pendingAutomatedRolloutsobject[]

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

timenumber
passPercentnumberrequired
returnValueJson5string
variantsobject[]
idstring
namestringrequired
passPercentagenumberrequired
Constraints:min: 0max: 100
returnValueobject
returnValueJson5string
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.

Example:{"ownerID":"user123","ownerType":"USER","ownerName":"John Doe","ownerEmail":"owner123@test.com"}
Constraints:nullable
ownerIDstring

ID of the owner

Example:abc123
ownerTypestring

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

Example:USER
ownerNamestring

The name of the owner. This field is optional.

Example:John Doe
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.

Constraints:nullable
schemaJson5string

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

Constraints:nullable
releasePipelineIDstring

The release pipeline ID associated with the dynamic config

Constraints:nullable
isTemplateboolean
statusstring
Allowed values:EnabledDisabledArchived
checksPerHournumber
Constraints:format: doublenullable
permalinkstringrequired

A permalink to this dynamic config in the Statsig Console.

Constraints:format: uri
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.

Allowed values:PERMANENTTEMPORARYSTALETEMPLATE
typeReasonstringrequired

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

Allowed values:NONESTALE_PROBABLY_DEAD_CHECKSTALE_NO_RULESSTALE_PROBABLY_FORGOTTENSTALE_PROBABLY_LAUNCHEDSTALE_PROBABLY_UNLAUNCHED
isPermanentbooleanrequired

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

Was this helpful?