Export state (deprecated)
GET <your-unleash-url>/api/admin/state/export
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
deprecated
This endpoint has been deprecated and may be removed in future versions of the API.
Exports the current state of the system. Deprecated in favor of /api/admin/features-batch/export
Request
Query Parameters
- format string
Possible values: [
json
,yaml
]Default value:
json
Desired export format. Must be either
json
oryaml
. - download any
Whether exported data should be downloaded as a file.
- strategies any
Whether strategies should be included in the exported data.
- featureToggles any
Whether feature toggles should be included in the exported data.
- projects any
Whether projects should be included in the exported data.
- tags any
Whether tag types, tags, and feature_tags should be included in the exported data.
- environments any
Whether environments should be included in the exported data.
Responses
- 200
stateSchema
- application/json
- Schema
- Example (from schema)
Schema
- version integer required
The version of the schema used to describe the state
features object[]
strategies object[]
tags object[]
tagTypes object[]
featureTags object[]
projects object[]
featureStrategies object[]
featureEnvironments object[]
environments object[]
segments object[]
featureStrategySegments object[]
{
"version": 1,
"features": [
{
"name": "disable-comments",
"type": "kill-switch",
"description": "Controls disabling of the comments section in case of an incident",
"archived": true,
"project": "dx-squad",
"enabled": true,
"stale": false,
"favorite": true,
"impressionData": false,
"createdAt": "2023-01-28T15:21:39.975Z",
"archivedAt": "2023-01-29T15:21:39.975Z",
"environments": [
{
"name": "my-dev-env",
"featureName": "disable-comments",
"environment": "development",
"type": "development",
"enabled": true,
"sortOrder": 3,
"variantCount": 0,
"strategies": [
{
"id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
"name": "flexibleRollout",
"title": "Gradual Rollout 25-Prod",
"disabled": false,
"featureName": "myAwesomeFeature",
"sortOrder": 9999,
"segments": [
1,
2
],
"constraints": [
{
"contextName": "appName",
"operator": "IN",
"caseInsensitive": false,
"inverted": false,
"values": [
"my-app",
"my-other-app"
],
"value": "my-app"
}
],
"variants": [
{
"name": "blue_group",
"weight": 0,
"weightType": "fix",
"stickiness": "custom.context.field",
"payload": {
"type": "json",
"value": "{\"color\": \"red\"}"
}
}
],
"parameters": {}
}
],
"variants": [
{
"name": "blue_group",
"weight": 0,
"weightType": "variable",
"stickiness": "custom.context.field",
"payload": {
"type": "json",
"value": "{\"color\": \"red\"}"
},
"overrides": [
{
"contextName": "userId",
"values": [
"red",
"blue"
]
}
]
}
],
"lastSeenAt": "2023-01-28T16:21:39.975Z",
"hasStrategies": true,
"hasEnabledStrategies": true
}
],
"tags": [
{
"value": "a-tag-value",
"type": "simple"
}
],
"children": [
"some-feature"
],
"lifecycle": {
"stage": "initial",
"enteredStageAt": "2023-01-28T15:21:39.975Z"
},
"dependencies": [
{
"feature": "some-feature",
"enabled": true,
"variants": [
"some-feature-blue-variant"
]
}
]
}
],
"strategies": [
{
"title": "GradualRollout - Prod25",
"name": "flexibleRollout",
"displayName": "Gradual Rollout",
"description": "Gradual rollout to logged in users",
"editable": true,
"deprecated": true,
"parameters": [
{
"name": "percentage",
"type": "percentage",
"description": "Gradual rollout to logged in users",
"required": true
}
]
}
],
"tags": [
{
"value": "a-tag-value",
"type": "simple"
}
],
"tagTypes": [
{
"name": "color",
"description": "A tag type for describing the color of a tag.",
"icon": "not-really-used"
}
],
"featureTags": [
{
"featureName": "my-feature",
"tagType": "simple",
"tagValue": "my-tag",
"createdByUserId": 1
}
],
"projects": [
{
"id": "dx-squad",
"name": "DX-Squad",
"description": "DX squad feature release",
"health": 50,
"featureCount": 10,
"staleFeatureCount": 10,
"potentiallyStaleFeatureCount": 10,
"memberCount": 4,
"createdAt": "2023-07-27T12:12:28Z",
"updatedAt": "2023-07-28T12:12:28Z",
"favorite": true,
"mode": "open",
"defaultStickiness": "userId",
"avgTimeToProduction": 10,
"owners": [
null
]
}
],
"featureStrategies": [
{
"id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
"name": "flexibleRollout",
"title": "Gradual Rollout 25-Prod",
"disabled": false,
"featureName": "myAwesomeFeature",
"sortOrder": 9999,
"segments": [
1,
2
],
"constraints": [
{
"contextName": "appName",
"operator": "IN",
"caseInsensitive": false,
"inverted": false,
"values": [
"my-app",
"my-other-app"
],
"value": "my-app"
}
],
"variants": [
{
"name": "blue_group",
"weight": 0,
"weightType": "fix",
"stickiness": "custom.context.field",
"payload": {
"type": "json",
"value": "{\"color\": \"red\"}"
}
}
],
"parameters": {}
}
],
"featureEnvironments": [
{
"name": "my-dev-env",
"featureName": "disable-comments",
"environment": "development",
"type": "development",
"enabled": true,
"sortOrder": 3,
"variantCount": 0,
"strategies": [
{
"id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
"name": "flexibleRollout",
"title": "Gradual Rollout 25-Prod",
"disabled": false,
"featureName": "myAwesomeFeature",
"sortOrder": 9999,
"segments": [
1,
2
],
"constraints": [
{
"contextName": "appName",
"operator": "IN",
"caseInsensitive": false,
"inverted": false,
"values": [
"my-app",
"my-other-app"
],
"value": "my-app"
}
],
"variants": [
{
"name": "blue_group",
"weight": 0,
"weightType": "fix",
"stickiness": "custom.context.field",
"payload": {
"type": "json",
"value": "{\"color\": \"red\"}"
}
}
],
"parameters": {}
}
],
"variants": [
{
"name": "blue_group",
"weight": 0,
"weightType": "variable",
"stickiness": "custom.context.field",
"payload": {
"type": "json",
"value": "{\"color\": \"red\"}"
},
"overrides": [
{
"contextName": "userId",
"values": [
"red",
"blue"
]
}
]
}
],
"lastSeenAt": "2023-01-28T16:21:39.975Z",
"hasStrategies": true,
"hasEnabledStrategies": true
}
],
"environments": [
{
"name": "my-dev-env",
"type": "development",
"enabled": true,
"protected": true,
"sortOrder": 3,
"projectCount": 10,
"apiTokenCount": 6,
"enabledToggleCount": 10
}
],
"segments": [
{
"id": 0,
"name": "segment A",
"constraints": [
{
"contextName": "appName",
"operator": "IN",
"caseInsensitive": false,
"inverted": false,
"values": [
"my-app",
"my-other-app"
],
"value": "my-app"
}
],
"description": "Segment A description",
"createdAt": "2023-07-05T12:56:00.000Z",
"createdBy": "johndoe",
"project": "default"
}
],
"featureStrategySegments": [
{
"segmentId": 2,
"featureStrategyId": "e2caa08f-30c4-4aa3-b955-54ca9e93dc13"
}
]
}
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
python / requests
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
go / native
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
nodejs / axios
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ruby / Net::HTTP
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
csharp / RestSharp
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
php / cURL
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
java / OkHttp
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
powershell / RestMethod
curl -L -X GET '<your-unleash-url>/api/admin/state/export' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'