Schemathesis 4.30.1
API Coverage Report
2026-10-10 12:33:52
Operations
Operations called at least once
100% 211 of 211 called
Parameters
Tested with valid and invalid values
99.4% 333 of 335 covered
Keywords
Constraints tested both ways
98.8% 2234 of 2260 covered
Examples
Schema examples sent in tests
99.8% 752 of 753 used
Responses
Documented response codes hit
61.5% 441 of 717 received
Show
Addons 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200addonsSchema42811ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Body
application/json14 / 14
addonCreateUpdateSchema
#validinvalidschema
11081225{
21169124 "properties": {
364222 "description": {
464222 "type": "string"
564222 },
6128210 "enabled": {
7128210 "type": "boolean"
8128210 },
962924 "environments": {
106296 "items": {
11231911 "type": "string"
126296 },
1363518 "type": "array"
1462924 },
15124348 "events": {
16124324 "items": {
17586663 "type": "string"
18124324 },
19126724 "type": "array"
20124348 },
21127417 "parameters": {
221061n/a "additionalProperties": {},
23127417 "type": "object"
24127417 },
2567837 "projects": {
2667819 "items": {
272851102 "type": "string"
2867819 },
2969718 "type": "array"
3067837 },
31119614 "provider": {
32119614 "type": "string"
33119614 }
341169124 },
35120593 "required": [
36121088 "provider",
3712926 "enabled",
3812917 "parameters",
3912917 "events"
40120593 ],
4112988 "type": "object"
421081225}
Responses
codedescriptionhitsavg
200addonSchema0never seen
400The request data does not match what we expect.18251ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
413The request body is larger than what we accept. By default we only accept bodies of 100kB or less0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Examples
Body: application/json
"This addon posts updates to our internal feature tracking system whenever a feature is created or updated."addonCreateUpdateSchema.description
[ "development", "production" ]addonCreateUpdateSchema.environments
[ "feature-created", "feature-updated" ]addonCreateUpdateSchema.events
{ "url": "http://localhost:4242/webhook" }addonCreateUpdateSchema.parameters
[ "new-landing-project", "signups-v2" ]addonCreateUpdateSchema.projects
"webhook"addonCreateUpdateSchema.provider
Path Parameters
id1 / 1
#validinvalidschema
15615n/a{
25615n/a "type": "string"
35615n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.921ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error55231ms
Path Parameters
id1 / 1
#validinvalidschema
1939n/a{
2939n/a "type": "string"
3939n/a}
Responses
codedescriptionhitsavg
200addonSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found891ms
500Internal Server Error8501ms
Path Parameters
id1 / 1
#validinvalidschema
1983n/a{
2983n/a "type": "string"
3983n/a}
Body
application/json14 / 14
addonCreateUpdateSchema
1331163{
2379110 "properties": {
323227 "description": {
423227 "type": "string"
523227 },
646820 "enabled": {
746820 "type": "boolean"
846820 },
922623 "environments": {
1022614 "items": {
1172575 "type": "string"
1222614 },
132409 "type": "array"
1422623 },
1544741 "events": {
1644721 "items": {
171536103 "type": "string"
1844721 },
1946820 "type": "array"
2044741 },
214817 "parameters": {
22368n/a "additionalProperties": {},
234817 "type": "object"
244817 },
2521133 "projects": {
262117 "items": {
2780112 "type": "string"
282117 },
2921826 "type": "array"
3021133 },
3143410 "provider": {
3243410 "type": "string"
3343410 }
34379110 },
3544148 "required": [
3644445 "provider",
374881 "enabled",
384881 "parameters",
394881 "events"
4044148 ],
414895 "type": "object"
42331163}
Responses
codedescriptionhitsavg
200addonSchema0never seen
400The request data does not match what we expect.6251ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.431ms
413The request body is larger than what we accept. By default we only accept bodies of 100kB or less0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error3121ms
Examples
Body: application/json
"This addon posts updates to our internal feature tracking system whenever a feature is created or updated."addonCreateUpdateSchema.description
[ "development", "production" ]addonCreateUpdateSchema.environments
[ "feature-created", "feature-updated" ]addonCreateUpdateSchema.events
{ "url": "http://localhost:4242/webhook" }addonCreateUpdateSchema.parameters
[ "new-landing-project", "signups-v2" ]addonCreateUpdateSchema.projects
"webhook"addonCreateUpdateSchema.provider
Path Parameters
id1 / 1
#validinvalidschema
1911n/a{
2911n/a "type": "string"
3911n/a}
Query Parameters
limit1 / 1
1315n/a{
2315n/a "type": "string"
3315n/a}
offset1 / 1
1290n/a{
2290n/a "type": "string"
3290n/a}
Responses
codedescriptionhitsavg
200#/components/schemas/integrationEventsSchema4041ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5041ms
Examples
Query
"50"limit
"50"offset
Admin UI 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json5 / 5
feedbackCreateSchema
#validinvalidschema
11142251{
2121097 "properties": {
3116079 "feedbackId": {
4116079 "type": "string"
5116079 },
662679 "neverShow": {
762679 "type": "boolean"
862679 }
9121097 },
101239138 "required": [
111239138 "feedbackId"
121239138 ],
13137716 "type": "object"
141142251}
Responses
codedescriptionhitsavg
200feedbackResponseSchema0never seen
400The request data does not match what we expect.10361ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error8981ms
Examples
Body: application/json
"pnps"feedbackCreateSchema.feedbackId
falsefeedbackCreateSchema.neverShow
Path Parameters
id1 / 1
#validinvalidschema
1835n/a{
2835n/a "type": "string"
3835n/a}
Body
application/json7 / 7
feedbackUpdateSchema
1312307{
2158242 "properties": {
3148186 "given": {
412740 "format": "date-time",
5334n/a "nullable": true,
6188146 "type": "string"
7148186 },
8136130 "neverShow": {
9136130 "type": "boolean"
10136130 },
11189111 "userId": {
12189111 "type": "integer"
13189111 }
14158242 },
1555465 "type": "object"
16312307}
Responses
codedescriptionhitsavg
200feedbackResponseSchema0never seen
400The request data does not match what we expect.5081ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error3242ms
Examples
Body: application/json
"2023-07-06T08:29:21.282Z"feedbackUpdateSchema.given
falsefeedbackUpdateSchema.neverShow
2feedbackUpdateSchema.userId
Body
application/json5 / 5
recordUiErrorSchema
#validinvalidschema
1298467{
2347370 "properties": {
3324344 "errorMessage": {
4324344 "type": "string"
5324344 },
6205361 "errorStack": {
7205361 "type": "string"
8205361 }
9347370 },
1066881 "required": [
1166881 "errorMessage"
1266881 ],
1374916 "type": "object"
14298467}
Responses
codedescriptionhitsavg
204This response has no body.4221ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
400Bad Request3961ms
Path Parameters
id1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200splashResponseSchema8021ms
400The request data does not match what we expect.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.0never seen
Responses
codedescriptionhitsavg
200uiConfigSchema8021ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Body
application/json4 / 4
setCorsSchema
#validinvalidschema
1190562{
2n/a0 "additionalProperties": false,
3128366 "properties": {
4128366 "frontendApiOrigins": {
5128245 "items": {
6334904 "type": "string"
7128245 },
8373121 "type": "array"
9128366 }
10128366 },
11556196 "type": "object"
12190562}
Responses
codedescriptionhitsavg
204This response has no body.515ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
41531ms
400Bad Request7061ms
404Not Found621ms
Examples
Body: application/json
[ "*" ]setCorsSchema.frontendApiOrigins
API tokens 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200apiTokensSchema8024ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Body
application/json14 / 14
createApiTokenSchema
#validinvalidschema
1693204{
2693204 "oneOf": [
3693204 {
4697168 "properties": {
519229 "environment": {
619229 "type": "string"
719229 },
819343 "expiresAt": {
919311 "format": "date-time",
1020432 "type": "string"
1119343 },
1218833 "project": {
1318833 "type": "string"
1418833 },
1517453 "projects": {
1617421 "items": {
1755163 "type": "string"
1817421 },
1919532 "type": "array"
2017453 },
2181443 "tokenName": {
2281443 "type": "string"
2381443 },
2479945 "type": {
2579920 "pattern": "^([Cc][Ll][Ii][Ee][Nn][Tt]|[Bb][Aa][Cc][Kk][Ee][Nn][Dd]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$",
2681925 "type": "string"
2779945 }
28697168 },
2984052 "required": [
3084448 "type",
3185735 "tokenName"
3284052 ],
338925 "type": "object"
34693204 }
35693204 ],
368925 "type": "object"
37693204}
Responses
codedescriptionhitsavg
201The resource was successfully created.5515ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4021ms
500Internal Server Error11ms
Examples
Body: application/json
"development"createApiTokenSchema.environment
"2023-07-04T11:26:24+02:00"createApiTokenSchema.expiresAt
"project-851"createApiTokenSchema.project
[ "project-851", "project-852" ]createApiTokenSchema.projects
"token-64522"createApiTokenSchema.tokenName
"frontend"createApiTokenSchema.type
Path Parameters
name1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200apiTokensSchema8022ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Path Parameters
token1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200This response has no body.8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Path Parameters
token1 / 1
#validinvalidschema
1820n/a{
2820n/a "type": "string"
3820n/a}
Body
application/json5 / 5
updateApiTokenSchema
1630153{
2630102 "properties": {
3630102 "expiresAt": {
463073 "format": "date-time",
570329 "type": "string"
6630102 }
7630102 },
873243 "required": [
973243 "expiresAt"
1073243 ],
117758 "type": "object"
12630153}
Responses
codedescriptionhitsavg
200This response has no body.6271ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1871ms
Examples
Body: application/json
"2023-09-04T11:26:24+02:00"updateApiTokenSchema.expiresAt
Archive 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
featureName1 / 1
#validinvalidschema
1905n/a{
2905n/a "type": "string"
3905n/a}
Responses
codedescriptionhitsavg
200This response has no body.8463ms
400The request data does not match what we expect.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found561ms
Path Parameters
featureName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200This response has no body.8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
1851n/a{
2851n/a "type": "string"
3851n/a}
Body
application/json5 / 5
batchFeaturesSchema
1353405{
2353265 "properties": {
3353265 "features": {
4353225 "items": {
512101119 "type": "string"
6353225 },
757840 "type": "array"
8353265 }
9353265 },
10618130 "required": [
11618130 "features"
12618130 ],
1374810 "type": "object"
14353405}
Responses
codedescriptionhitsavg
200This response has no body.4672ms
400The request data does not match what we expect.3671ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error142ms
Examples
Body: application/json
[ "my-feature-4", "my-feature-5", "my-feature-6" ]batchFeaturesSchema.features
Path Parameters
projectId1 / 1
#validinvalidschema
1850n/a{
2850n/a "type": "string"
3850n/a}
Body
application/json5 / 5
batchFeaturesSchema
1314437{
2314230 "properties": {
3314230 "features": {
4314136 "items": {
51027618 "type": "string"
6314136 },
745094 "type": "array"
8314230 }
9314230 },
10544188 "required": [
11544188 "features"
12544188 ],
1373219 "type": "object"
14314437}
Responses
codedescriptionhitsavg
200This response has no body.3422ms
400The request data does not match what we expect.4701ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found252ms
500Internal Server Error102ms
Examples
Body: application/json
[ "my-feature-4", "my-feature-5", "my-feature-6" ]batchFeaturesSchema.features
Auth 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json5 / 5
changePasswordSchema
#validinvalidschema
1194167{
2n/a0 "additionalProperties": false,
324783 "properties": {
424778 "password": {
524778 "type": "string"
624778 },
721072 "token": {
821072 "type": "string"
921072 }
1024783 },
1127763 "required": [
1228258 "token",
1332515 "password"
1427763 ],
1534021 "type": "object"
16194167}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.51ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request8141ms
Examples
Body: application/json
"correct horse battery staple"changePasswordSchema.password
"$2a$15$QzeW/y5/MEppCWVEkoX5euejobYOLSd4We21LQjjKlWH9l2I3wCke"changePasswordSchema.token
Body
application/json4 / 4
emailSchema
#validinvalidschema
1213526{
2n/a0 "additionalProperties": false,
3213369 "properties": {
4213369 "email": {
5213369 "type": "string"
6213369 }
7213369 },
8582123 "required": [
9582123 "email"
10582123 ],
1170534 "type": "object"
12213526}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.18ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
429Too Many Requests8070ms
400Bad Request71ms
500Internal Server Error11ms
Examples
Body: application/json
"test@example.com"emailSchema.email
Responses
codedescriptionhitsavg
200tokenUserSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.17041ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.0never seen
Body
application/json4 / 4
validatePasswordSchema
#validinvalidschema
1227511{
2n/a0 "additionalProperties": false,
322796 "properties": {
422796 "password": {
522796 "type": "string"
622796 }
722796 },
832378 "required": [
932378 "password"
1032378 ],
11401337 "type": "object"
12227511}
Responses
codedescriptionhitsavg
200This response has no body.401ms
400The request data does not match what we expect.7931ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Examples
Body: application/json
"hunter2"validatePasswordSchema.password
Body
application/json5 / 5
loginSchema
#validinvalidschema
1176160{
2n/a0 "additionalProperties": false,
323757 "properties": {
424148 "password": {
524148 "type": "string"
624148 },
719939 "username": {
819939 "type": "string"
919939 }
1023757 },
1123373 "required": [
1223868 "username",
1328917 "password"
1423373 ],
1530630 "type": "object"
16176160}
Responses
codedescriptionhitsavg
200userSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.437ms
Undocumented - not in spec
codedescriptionhitsavg
41511ms
400Bad Request411ms
429Too Many Requests7370ms
Examples
Body: application/json
"hunter2"loginSchema.password
"user"loginSchema.username
Client 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200clientFeaturesSchema0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden8020ms
Path Parameters
featureName1 / 1
#validinvalidschema
1860n/a{
2860n/a "type": "string"
3860n/a}
Responses
codedescriptionhitsavg
200clientFeatureSchema0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden8600ms
Body
application/json36 / 36
clientMetricsSchema
#validinvalidschema
1287245{
2310216 "properties": {
345845 "appName": {
445840 "minLength": 1,
54985 "type": "string"
645845 },
7216120 "bucket": {
8336n/a "nullable": true,
9164104 "properties": {
1023136 "start": {
12 "example": "1926-05-08T12:00:00.000Z"
1323136 },
1423136 "stop": {
16 "example": "1926-05-08T13:00:00.000Z"
1723136 },
1819077 "toggles": {
199970 "additionalProperties": {
20258167 "properties": {
2132917 "no": {
223303 "minimum": 0,
2333214 "type": "integer"
2432917 },
25205111 "variants": {
2611685 "additionalProperties": {
27357259 "minimum": 0,
2861518 "type": "integer"
2911685 },
30316n/a "nullable": true,
3129026 "type": "object"
32205111 },
3331459 "yes": {
3431429 "minimum": 0,
3534330 "type": "number"
3631459 }
37258167 },
3849011 "type": "object"
399970 },
402607 "type": "object"
4119077 }
42164104 },
432654 "required": [
442672 "start",
452672 "stop",
462672 "toggles"
472654 ],
4832412 "type": "object"
49216120 },
503036 "instanceId": {
513036 "type": "string"
523036 },
532826 "platformName": {
542826 "type": "string"
552826 },
5626315 "platformVersion": {
5726315 "type": "string"
5826315 },
5926615 "sdkFlavor": {
602669 "maxLength": 256,
612756 "type": "string"
6226615 },
6327116 "sdkFlavorVersion": {
642719 "maxLength": 32,
652807 "type": "string"
6627116 },
6729818 "sdkVersion": {
6829818 "type": "string"
6929818 },
702935 "specVersion": {
712935 "type": "string"
722935 },
732856 "yggdrasilVersion": {
742856 "type": "string"
752856 }
76310216 },
7750324 "required": [
7850324 "appName"
7950324 ],
805275 "type": "object"
81287245}
Referenced Components (1)5 of 5 keywords
dateSchema5 of 5 keywords
146272{
246272 "oneOf": [
3130404 {
413040 "format": "date-time",
5170364 "type": "string"
6130404 },
7332202 {
8332202 "type": "integer"
9332202 }
1046272 ]
1146272}
Responses
codedescriptionhitsavg
202This response has no body.0never seen
204This response has no body.0never seen
400The request data does not match what we expect.4241ms
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden5351ms
Examples
Body: application/json
"insurance-selector"clientMetricsSchema.appName
"2023-07-27T11:23:44Z"dateSchema
1690449593dateSchema
50clientMetricsSchema.bucket.toggles.no
{ "variantA": 15, "variantB": 25, "variantC": 5 }clientMetricsSchema.bucket.toggles.variants
974clientMetricsSchema.bucket.toggles.yes
{ "myCoolToggle": { "no": 42, "variants": { "blue": 6, "green": 15, "red": 46 }, "yes": 25 }, "myOtherToggle": { "no": 100, "yes": 0 } }clientMetricsSchema.bucket.toggles
"application-name-dacb1234"clientMetricsSchema.instanceId
".NET Core"clientMetricsSchema.platformName
"3.1"clientMetricsSchema.platformVersion
"unleash-openfeature-node-provider"clientMetricsSchema.sdkFlavor
"1.0.1"clientMetricsSchema.sdkFlavorVersion
"unleash-client-java:7.0.0"clientMetricsSchema.sdkVersion
"3.0.0"clientMetricsSchema.specVersion
"1.0.0"clientMetricsSchema.yggdrasilVersion
Body
application/json23 / 23
clientApplicationSchema
#validinvalidschema
1280207{
2296182 "properties": {
341848 "appName": {
441839 "minLength": 1,
54579 "type": "string"
641848 },
721314 "instanceId": {
821314 "type": "string"
921314 },
1044530 "interval": {
1144523 "minimum": 0,
124687 "type": "number"
1344530 },
142085 "platformName": {
152085 "type": "string"
162085 },
172278 "platformVersion": {
182278 "type": "string"
192278 },
2020016 "sdkFlavor": {
212009 "maxLength": 256,
222097 "type": "string"
2320016 },
2420425 "sdkFlavorVersion": {
252049 "maxLength": 32,
2621316 "type": "string"
2720425 },
2821827 "sdkVersion": {
2921827 "type": "string"
3021827 },
312188 "specVersion": {
322188 "type": "string"
332188 },
3446214 "started": {
3546214 "oneOf": [
36361115 {
373615 "format": "date-time",
38366110 "type": "string"
39361115 },
40101375 {
41101375 "type": "number"
42101375 }
4346214 ]
4446214 },
4544531 "strategies": {
4644519 "items": {
471708122 "type": "string"
4844519 },
4946412 "type": "array"
5044531 },
5120212 "yggdrasilVersion": {
5220212 "type": "string"
5320212 }
54296182 },
5546217 "required": [
5646613 "appName",
574754 "interval",
584763 "started",
594763 "strategies"
6046217 ],
614798 "type": "object"
62280207}
Responses
codedescriptionhitsavg
202This response has no body.0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden4901ms
400Bad Request4190ms
Examples
Body: application/json
"example-app"clientApplicationSchema.appName
"b77f3d13-5f48-4a7b-a3f4-a449b97ce43a"clientApplicationSchema.instanceId
10clientApplicationSchema.interval
".NET Core"clientApplicationSchema.platformName
"3.1"clientApplicationSchema.platformVersion
"unleash-openfeature-node-provider"clientApplicationSchema.sdkFlavor
"1.0.1"clientApplicationSchema.sdkFlavorVersion
"unleash-client-java:7.0.0"clientApplicationSchema.sdkVersion
"3.0.0"clientApplicationSchema.specVersion
"2023-06-13T16:35:00.000Z"clientApplicationSchema.started
[ "default", "gradualRollout", "remoteAddress" ]clientApplicationSchema.strategies
"1.0.0"clientApplicationSchema.yggdrasilVersion
Context 16 operations 16 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
include1 / 1
#validinvalidschema
1338n/a{
2338n/a "type": "string"
3338n/a}
Responses
codedescriptionhitsavg
200contextFieldsSchema8032ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Examples
Query
"project"include
Body
application/json15 / 15
createContextFieldSchema
#validinvalidschema
1546266{
2576216 "properties": {
333143 "description": {
433143 "type": "string"
533143 },
6234160 "legalValues": {
723492 "items": {
923492 },
1032668 "type": "array"
11234160 },
1273824 "name": {
1373824 "type": "string"
1473824 },
1528821 "project": {
1628821 "type": "string"
1728821 },
1826976 "sortOrder": {
1926976 "type": "integer"
2026976 },
2130235 "stickiness": {
2230235 "type": "boolean"
2330235 }
24576216 },
2576240 "required": [
2676240 "name"
2776240 ],
2880210 "type": "object"
29546266}
Referenced Components (1)7 of 7 keywords
legalValueSchema7 of 7 keywords
1891244{
2n/a0 "additionalProperties": false,
3909178 "properties": {
439423 "description": {
539423 "type": "string"
639423 },
7908161 "value": {
8908161 "type": "string"
9908161 }
10909178 },
11106941 "required": [
12106941 "value"
13106941 ],
14111025 "type": "object"
15891244}
Responses
codedescriptionhitsavg
201The resource was successfully created.385ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error232ms
41531ms
400Bad Request5651ms
409Conflict3421ms
401Unauthorized31ms
Examples
Body: application/json
"The user's subscription tier"createContextFieldSchema.description
[ { "value": "gold" }, { "value": "silver" }, { "value": "crystal" } ]createContextFieldSchema.legalValues
"Deep fuchsia"legalValueSchema.description
"#c154c1"legalValueSchema.value
"subscriptionTier"createContextFieldSchema.name
"my-project"createContextFieldSchema.project
2createContextFieldSchema.sortOrder
falsecreateContextFieldSchema.stickiness
Body
application/json4 / 4
nameSchema
#validinvalidschema
1280543{
2n/a0 "additionalProperties": false,
3280357 "properties": {
4280357 "name": {
5280357 "type": "string"
6280357 }
7280357 },
8637122 "required": [
9637122 "name"
10637122 ],
1175964 "type": "object"
12280543}
Responses
codedescriptionhitsavg
200This response has no body.1141ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
41531ms
400Bad Request7091ms
409Conflict901ms
Examples
Body: application/json
"betaUser"nameSchema.name
Path Parameters
contextField1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200This response has no body.24ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found8001ms
401Unauthorized31ms
Path Parameters
contextField1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200contextFieldSchema901ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found7121ms
401Unauthorized31ms
Path Parameters
contextField1 / 1
#validinvalidschema
1868n/a{
2868n/a "type": "string"
3868n/a}
Body
application/json13 / 13
updateContextFieldSchema
1268207{
2158172 "properties": {
316165 "description": {
416165 "type": "string"
516165 },
6132105 "legalValues": {
713288 "items": {
913288 },
1022017 "type": "array"
11132105 },
1217934 "project": {
1317934 "type": "string"
1417934 },
1516941 "sortOrder": {
1616941 "type": "integer"
1716941 },
1818348 "stickiness": {
1918348 "type": "boolean"
2018348 }
21158172 },
2244035 "type": "object"
23268207}
Referenced Components (1)7 of 7 keywords
legalValueSchema7 of 7 keywords
1566377{
2n/a0 "additionalProperties": false,
3622251 "properties": {
441049 "description": {
541049 "type": "string"
641049 },
7584233 "value": {
8584233 "type": "string"
9584233 }
10622251 },
1181795 "required": [
1281795 "value"
1381795 ],
1491231 "type": "object"
15566377}
Responses
codedescriptionhitsavg
200This response has no body.334ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error133ms
41531ms
400Bad Request5491ms
404Not Found2671ms
401Unauthorized31ms
Examples
Body: application/json
"The user's subscription tier"updateContextFieldSchema.description
[ { "value": "gold" }, { "value": "silver" }, { "value": "crystal" } ]updateContextFieldSchema.legalValues
"Deep fuchsia"legalValueSchema.description
"#c154c1"legalValueSchema.value
"my-project"updateContextFieldSchema.project
2updateContextFieldSchema.sortOrder
falseupdateContextFieldSchema.stickiness
Path Parameters
contextField1 / 1
#validinvalidschema
1925n/a{
2925n/a "type": "string"
3925n/a}
Body
application/json5 / 5
legalValueSchema
1220207{
2n/a0 "additionalProperties": false,
3256114 "properties": {
49491 "description": {
59491 "type": "string"
69491 },
723599 "value": {
823599 "type": "string"
923599 }
10256114 },
1133483 "required": [
1233483 "value"
1333483 ],
1441710 "type": "object"
15220207}
Responses
codedescriptionhitsavg
200This response has no body.414ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
41531ms
400Bad Request6701ms
404Not Found2081ms
Examples
Body: application/json
"Deep fuchsia"legalValueSchema.description
"#c154c1"legalValueSchema.value
Path Parameters
projectId1 / 1
#validinvalidschema
1842n/a{
2842n/a "type": "string"
3842n/a}
Query Parameters
include1 / 1
1217n/a{
2217n/a "type": "string"
3217n/a}
Responses
codedescriptionhitsavg
200contextFieldsSchema8392ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Examples
Query
"project"include
Path Parameters
projectId1 / 1
#validinvalidschema
1911n/a{
2911n/a "type": "string"
3911n/a}
Body
application/json15 / 15
createContextFieldSchema
1588206{
2620150 "properties": {
327026 "description": {
427026 "type": "string"
527026 },
619477 "legalValues": {
719446 "items": {
919446 },
1024031 "type": "array"
1119477 },
1272216 "name": {
1372216 "type": "string"
1472216 },
1522513 "project": {
1622513 "type": "string"
1722513 },
1822835 "sortOrder": {
1922835 "type": "integer"
2022835 },
2119054 "stickiness": {
2219054 "type": "boolean"
2319054 }
24620150 },
2573848 "required": [
2673848 "name"
2773848 ],
287868 "type": "object"
29588206}
Referenced Components (1)7 of 7 keywords
legalValueSchema7 of 7 keywords
185999{
2n/a0 "additionalProperties": false,
386939 "properties": {
434423 "description": {
534423 "type": "string"
634423 },
788216 "value": {
888216 "type": "string"
988216 }
1086939 },
1189825 "required": [
1289825 "value"
1389825 ],
1492335 "type": "object"
1585999}
Responses
codedescriptionhitsavg
201The resource was successfully created.347ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
409Conflict3241ms
41531ms
400Bad Request5391ms
500Internal Server Error82ms
Examples
Body: application/json
"The user's subscription tier"createContextFieldSchema.description
[ { "value": "gold" }, { "value": "silver" }, { "value": "crystal" } ]createContextFieldSchema.legalValues
"Deep fuchsia"legalValueSchema.description
"#c154c1"legalValueSchema.value
"subscriptionTier"createContextFieldSchema.name
"my-project"createContextFieldSchema.project
2createContextFieldSchema.sortOrder
falsecreateContextFieldSchema.stickiness
Path Parameters
projectId1 / 1
#validinvalidschema
1839n/a{
2839n/a "type": "string"
3839n/a}
Body
application/json4 / 4
nameSchema
1348373{
2n/a0 "additionalProperties": false,
3348146 "properties": {
4348146 "name": {
5348146 "type": "string"
6348146 }
7348146 },
849495 "required": [
949495 "name"
1049495 ],
11589132 "type": "object"
12348373}
Responses
codedescriptionhitsavg
200This response has no body.1801ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
41530ms
400Bad Request5421ms
409Conflict1111ms
Examples
Body: application/json
"betaUser"nameSchema.name
Path Parameters
projectId1 / 1
#validinvalidschema
1616n/a{
2616n/a "type": "string"
3616n/a}
contextField1 / 1
1616n/a{
2616n/a "type": "string"
3616n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6161ms
Path Parameters
projectId1 / 1
#validinvalidschema
1829n/a{
2829n/a "type": "string"
3829n/a}
contextField1 / 1
1829n/a{
2829n/a "type": "string"
3829n/a}
Responses
codedescriptionhitsavg
200contextFieldSchema24ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
404Not Found8241ms
Path Parameters
projectId1 / 1
#validinvalidschema
1877n/a{
2877n/a "type": "string"
3877n/a}
contextField1 / 1
1877n/a{
2877n/a "type": "string"
3877n/a}
Body
application/json13 / 13
updateContextFieldSchema
1302147{
2129127 "properties": {
315333 "description": {
415333 "type": "string"
515333 },
69990 "legalValues": {
79972 "items": {
99972 },
1017118 "type": "array"
119990 },
1213611 "project": {
1313611 "type": "string"
1413611 },
1512323 "sortOrder": {
1612323 "type": "integer"
1712323 },
1814128 "stickiness": {
1914128 "type": "boolean"
2014128 }
21129127 },
2242920 "type": "object"
23302147}
Referenced Components (1)7 of 7 keywords
legalValueSchema7 of 7 keywords
1486249{
2n/a0 "additionalProperties": false,
3494203 "properties": {
425951 "description": {
525951 "type": "string"
625951 },
7531158 "value": {
8531158 "type": "string"
9531158 }
10494203 },
1168935 "required": [
1268935 "value"
1368935 ],
1472411 "type": "object"
15486249}
Responses
codedescriptionhitsavg
200This response has no body.63ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3061ms
41531ms
400Bad Request5381ms
500Internal Server Error212ms
401Unauthorized31ms
Examples
Body: application/json
"The user's subscription tier"updateContextFieldSchema.description
[ { "value": "gold" }, { "value": "silver" }, { "value": "crystal" } ]updateContextFieldSchema.legalValues
"Deep fuchsia"legalValueSchema.description
"#c154c1"legalValueSchema.value
"my-project"updateContextFieldSchema.project
2updateContextFieldSchema.sortOrder
falseupdateContextFieldSchema.stickiness
Path Parameters
projectId1 / 1
#validinvalidschema
1854n/a{
2854n/a "type": "string"
3854n/a}
contextField1 / 1
1854n/a{
2854n/a "type": "string"
3854n/a}
Body
application/json5 / 5
legalValueSchema
1306138{
2n/a0 "additionalProperties": false,
332172 "properties": {
49165 "description": {
59165 "type": "string"
69165 },
731563 "value": {
831563 "type": "string"
931563 }
1032172 },
1137838 "required": [
1237838 "value"
1337838 ],
1441628 "type": "object"
15306138}
Responses
codedescriptionhitsavg
200This response has no body.75ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3231ms
41530ms
400Bad Request5181ms
401Unauthorized31ms
Examples
Body: application/json
"Deep fuchsia"legalValueSchema.description
"#c154c1"legalValueSchema.value
Dependencies 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
projectId1 / 1
#validinvalidschema
1832n/a{
2832n/a "type": "string"
3832n/a}
Responses
codedescriptionhitsavg
200dependenciesExistSchema8291ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
1884n/a{
2884n/a "type": "string"
3884n/a}
child1 / 1
1884n/a{
2884n/a "type": "string"
3884n/a}
Responses
codedescriptionhitsavg
200This response has no body.311ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.8781ms
Path Parameters
projectId1 / 1
#validinvalidschema
1874n/a{
2874n/a "type": "string"
3874n/a}
child1 / 1
1874n/a{
2874n/a "type": "string"
3874n/a}
Body
application/json7 / 7
createDependentFeatureSchema
1292170{
2324102 "properties": {
313062 "enabled": {
413062 "type": "boolean"
513062 },
635143 "feature": {
735143 "type": "string"
835143 },
910984 "variants": {
1010950 "items": {
11432212 "type": "string"
1210950 },
1315934 "type": "array"
1410984 }
15324102 },
1639454 "required": [
1739454 "feature"
1839454 ],
1944814 "type": "object"
20292170}
Responses
codedescriptionhitsavg
200This response has no body.384ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation1092ms
404The requested resource was not found.1702ms
Undocumented - not in spec
codedescriptionhitsavg
41530ms
400Bad Request5511ms
Examples
Body: application/json
falsecreateDependentFeatureSchema.enabled
"parent_feature"createDependentFeatureSchema.feature
[ "variantA", "variantB" ]createDependentFeatureSchema.variants
Path Parameters
projectId1 / 1
#validinvalidschema
1847n/a{
2847n/a "type": "string"
3847n/a}
child1 / 1
1847n/a{
2847n/a "type": "string"
3847n/a}
parent1 / 1
1847n/a{
2847n/a "type": "string"
3847n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.8471ms
Path Parameters
projectId1 / 1
#validinvalidschema
1825n/a{
2825n/a "type": "string"
3825n/a}
child1 / 1
1825n/a{
2825n/a "type": "string"
3825n/a}
Responses
codedescriptionhitsavg
200parentFeatureOptionsSchema8221ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
1827n/a{
2827n/a "type": "string"
3827n/a}
parent1 / 1
1827n/a{
2827n/a "type": "string"
3827n/a}
Responses
codedescriptionhitsavg
200parentVariantOptionsSchema8241ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Environments 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200environmentsSchema18381ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
1821n/a{
2821n/a "type": "string"
3821n/a}
Responses
codedescriptionhitsavg
200environmentsProjectSchema8182ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Body
application/json2 / 2
sortOrderSchema
#validinvalidschema
1179558{
2135420 "additionalProperties": {
34011244 "type": "integer"
4135420 },
5599138 "type": "object"
6179558}
Responses
codedescriptionhitsavg
200This response has no body.1931ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
400Bad Request5881ms
500Internal Server Error321ms
Examples
Body: application/json
6sortOrderSchema
Path Parameters
name1 / 1
#validinvalidschema
11103n/a{
21103n/a "type": "string"
31103n/a}
Responses
codedescriptionhitsavg
200environmentSchema10081ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.921ms
Path Parameters
name1 / 1
#validinvalidschema
11046n/a{
21046n/a "type": "string"
31046n/a}
Responses
codedescriptionhitsavg
204This response has no body.9752ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.681ms
Path Parameters
name1 / 1
#validinvalidschema
1927n/a{
2927n/a "type": "string"
3927n/a}
Responses
codedescriptionhitsavg
204This response has no body.8442ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.801ms
Events 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200eventCreatorsSchema8022ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Query Parameters
project1 / 1
#validinvalidschema
1864n/a{
2864n/a "type": "string"
3864n/a}
Responses
codedescriptionhitsavg
200eventsSchema16282ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error21ms
Path Parameters
featureName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200featureEventsSchema8022ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Query Parameters
query1 / 1
#validinvalidschema
1248n/a{
2248n/a "type": "string"
3248n/a}
id2 / 2
121755{
221755 "pattern": "^(IS|IS_ANY_OF):(.*?)(,([0-9]+))*$",
3272n/a "type": "string"
421755}
groupId2 / 2
123446{
223446 "pattern": "^(IS|IS_ANY_OF):(.*?)(,([0-9]+))*$",
3280n/a "type": "string"
423446}
feature2 / 2
122429{
222429 "pattern": "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$",
3253n/a "type": "string"
422429}
project2 / 2
123356{
223356 "pattern": "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$",
3289n/a "type": "string"
423356}
type2 / 2
120839{
220839 "pattern": "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$",
3247n/a "type": "string"
420839}
createdBy2 / 2
123135{
223135 "pattern": "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$",
3266n/a "type": "string"
423135}
from2 / 2
126835{
226835 "pattern": "^(IS):\\d{4}-\\d{2}-\\d{2}$",
3303n/a "type": "string"
426835}
to2 / 2
124620{
224620 "pattern": "^(IS):\\d{4}-\\d{2}-\\d{2}$",
3266n/a "type": "string"
424620}
offset1 / 1
1237n/a{
2237n/a "type": "string"
3237n/a}
limit1 / 1
1226n/a{
2226n/a "type": "string"
3226n/a}
environment2 / 2
127432{
227432 "pattern": "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$",
3306n/a "type": "string"
427432}
Responses
codedescriptionhitsavg
200eventSearchResponseSchema6243ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
400Bad Request2521ms
500Internal Server Error1191ms
Examples
Query
"admin@example.com"query
"IS:123"id
"IS:123"groupId
"IS:myfeature"feature
"IS:default"project
"IS:change-added"type
"IS:2"createdBy
"IS:2024-01-01"from
"IS:2024-01-31"to
"0"offset
"50"offset
"50"limit
"50"limit
"IS:production"environment
Feature Types 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200featureTypesSchema17681ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Path Parameters
id1 / 1
#validinvalidschema
1918n/a{
2918n/a "type": "string"
3918n/a}
Body
application/json7 / 7
updateFeatureTypeLifetimeSchema
181271{
281229 "properties": {
381229 "lifetimeDays": {
45911 "maximum": 2147483647,
557913 "minimum": 0,
6841n/a "nullable": true,
781922 "type": "integer"
881229 }
981229 },
1084137 "required": [
1184137 "lifetimeDays"
1284137 ],
138785 "type": "object"
1481271}
Responses
codedescriptionhitsavg
200featureTypeSchema7574ms
400The request data does not match what we expect.941ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.611ms
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Examples
Body: application/json
7updateFeatureTypeLifetimeSchema.lifetimeDays
Features 43 operations 43 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json12 / 12
constraintSchema
#validinvalidschema
1510227{
2n/a0 "additionalProperties": false,
3547172 "properties": {
442186 "caseInsensitive": {
542186 "type": "boolean"
642186 },
765233 "contextName": {
865233 "type": "string"
965233 },
1025972 "inverted": {
1125972 "type": "boolean"
1225972 },
1369422 "operator": {
1469422 "enum": [
1531n/a "NOT_IN",
16220n/a "IN",
17137n/a "STR_ENDS_WITH",
1860n/a "STR_STARTS_WITH",
1912n/a "STR_CONTAINS",
208n/a "NUM_EQ",
2113n/a "NUM_GT",
2215n/a "NUM_GTE",
2319n/a "NUM_LT",
2414n/a "NUM_LTE",
2520n/a "DATE_AFTER",
2619n/a "DATE_BEFORE",
2714n/a "SEMVER_EQ",
2817n/a "SEMVER_GT",
2919n/a "SEMVER_LT",
3013n/a "SEMVER_GTE",
3118n/a "SEMVER_LTE",
3245n/a "REGEX"
3369422 ],
347115 "type": "string"
3569422 },
3624737 "value": {
3724723 "minLength": 1,
3827014 "type": "string"
3924737 },
4038526 "values": {
4138510 "items": {
4299429 "type": "string"
4338510 },
4439516 "type": "array"
4538526 }
46547172 },
4768246 "required": [
4868543 "contextName",
4971612 "operator"
5068246 ],
517289 "type": "object"
52510227}
Responses
codedescriptionhitsavg
204The constraint is valid1651ms
400The request data does not match what we expect.8101ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Examples
Body: application/json
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
Body
application/json6 / 6
validateFeatureSchema
#validinvalidschema
182962{
283730 "properties": {
384217 "name": {
484217 "type": "string"
584217 },
681820 "projectId": {
7838n/a "nullable": true,
881820 "type": "string"
981820 }
1083730 },
1185920 "required": [
1285920 "name"
1385920 ],
1487912 "type": "object"
1582962}
Responses
codedescriptionhitsavg
200This response has no body.2832ms
400The request data does not match what we expect.4561ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.1801ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.34ms
Examples
Body: application/json
"my-feature-3"validateFeatureSchema.name
"project-y"validateFeatureSchema.projectId
Path Parameters
featureName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200tagsSchema7671ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.351ms
Path Parameters
featureName1 / 1
#validinvalidschema
1946n/a{
2946n/a "type": "string"
3946n/a}
Body
application/json12 / 12
tagSchema
1403188{
2n/a0 "additionalProperties": false,
3417136 "properties": {
423055 "color": {
5285n/a "nullable": true,
619111 "pattern": "^#[0-9A-Fa-f]{6}$",
724144 "type": "string"
823055 },
947278 "type": {
1048823 "maxLength": 50,
1149516 "minLength": 2,
1251139 "type": "string"
1347278 },
1448161 "value": {
1550016 "maxLength": 50,
1649719 "minLength": 2,
1751626 "type": "string"
1848161 }
19417136 },
2053922 "required": [
2154219 "value",
2255011 "type"
2353922 ],
2456130 "type": "object"
25403188}
Responses
codedescriptionhitsavg
201The resource was successfully created.1266ms
400The request data does not match what we expect.7881ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.261ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
Examples
Body: application/json
"#FFFFFF"tagSchema.color
"simple"tagSchema.type
"a-tag-value"tagSchema.value
Path Parameters
featureName1 / 1
#validinvalidschema
1908n/a{
2908n/a "type": "string"
3908n/a}
Body
application/json19 / 19
updateTagsSchema
1314491{
2n/a0 "additionalProperties": false,
3337435 "properties": {
4381378 "addedTags": {
5381341 "items": {
7381341 },
872237 "type": "array"
9381378 },
10431331 "removedTags": {
11431299 "items": {
127911040 "$ref": "#/components/schemas/tagSchema"
13431299 },
1473032 "type": "array"
15431331 }
16337435 },
1774941 "required": [
1875931 "addedTags",
1976228 "removedTags"
2074941 ],
2179015 "type": "object"
22314491}
Referenced Components (1)14 of 14 keywords
tagSchema14 of 14 keywords
115752114{
2n/a3 "additionalProperties": false,
316661719 "properties": {
410341142 "color": {
52176n/a "nullable": true,
6483218 "pattern": "^#[0-9A-Fa-f]{6}$",
71252924 "type": "string"
810341142 },
92694622 "type": {
102853143 "maxLength": 50,
112837159 "minLength": 2,
122996320 "type": "string"
132694622 },
142704624 "value": {
152868124 "maxLength": 50,
162828164 "minLength": 2,
172992336 "type": "string"
182704624 }
1916661719 },
203267137 "required": [
21332876 "value",
22331688 "type"
233267137 ],
243404285 "type": "object"
2515752114}
Responses
codedescriptionhitsavg
200The resource was successfully created.1564ms
400The request data does not match what we expect.7321ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.141ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
Examples
Body: application/json
{ "addedTags": [ { "type": "simple", "value": "tag-to-add" } ], "removedTags": [ { "type": "simple", "value": "tag-to-remove" } ] }updateTagsSchema
"#FFFFFF"tagSchema.color
"simple"tagSchema.type
"a-tag-value"tagSchema.value
Path Parameters
featureName1 / 1
#validinvalidschema
1167n/a{
2167n/a "type": "string"
3167n/a}
type1 / 1
1167n/a{
2167n/a "type": "string"
3167n/a}
value1 / 1
1167n/a{
2167n/a "type": "string"
3167n/a}
Responses
codedescriptionhitsavg
200This response has no body.1583ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.61ms
Responses
codedescriptionhitsavg
200featureLifecycleCountSchema8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
1838n/a{
2838n/a "type": "string"
3838n/a}
Body
application/json5 / 5
batchFeaturesSchema
1290481{
2290357 "properties": {
3290357 "features": {
4290306 "items": {
59591351 "type": "string"
6290306 },
759651 "type": "array"
8290357 }
9290357 },
10647109 "required": [
11647109 "features"
12647109 ],
1375615 "type": "object"
14290481}
Responses
codedescriptionhitsavg
202This response has no body.4132ms
400The request data does not match what we expect.4111ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error82ms
Examples
Body: application/json
[ "my-feature-4", "my-feature-5", "my-feature-6" ]batchFeaturesSchema.features
Path Parameters
projectId1 / 1
#validinvalidschema
1843n/a{
2843n/a "type": "string"
3843n/a}
Body
application/json5 / 5
batchFeaturesSchema
1366394{
2366189 "properties": {
3366189 "features": {
4366156 "items": {
51372700 "type": "string"
6366156 },
752233 "type": "array"
8366189 }
9366189 },
10555182 "required": [
11555182 "features"
12555182 ],
1373723 "type": "object"
14366394}
Responses
codedescriptionhitsavg
200validateArchiveFeaturesSchema3711ms
400The request data does not match what we expect.4101ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error561ms
Examples
Body: application/json
[ "my-feature-4", "my-feature-5", "my-feature-6" ]batchFeaturesSchema.features
Path Parameters
projectId1 / 1
#validinvalidschema
1847n/a{
2847n/a "type": "string"
3847n/a}
environment1 / 1
1847n/a{
2847n/a "type": "string"
3847n/a}
Body
application/json5 / 5
bulkToggleFeaturesSchema
1425335{
2425193 "properties": {
3425193 "features": {
4425148 "items": {
51333700 "type": "string"
6425148 },
757345 "type": "array"
8425193 }
9425193 },
10618123 "required": [
11618123 "features"
12618123 ],
1374119 "type": "object"
14425335}
Responses
codedescriptionhitsavg
200This response has no body.1661ms
400The request data does not match what we expect.3721ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.3032ms
413The request body is larger than what we accept. By default we only accept bodies of 100kB or less0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Examples
Body: application/json
[ "feature-a", "feature-b" ]bulkToggleFeaturesSchema.features
Path Parameters
projectId1 / 1
#validinvalidschema
1851n/a{
2851n/a "type": "string"
3851n/a}
environment1 / 1
1851n/a{
2851n/a "type": "string"
3851n/a}
Body
application/json5 / 5
bulkToggleFeaturesSchema
1410385{
2410265 "properties": {
3410265 "features": {
4410181 "items": {
51472857 "type": "string"
6410181 },
759184 "type": "array"
8410265 }
9410265 },
1067557 "required": [
1167557 "features"
1267557 ],
1373263 "type": "object"
14410385}
Responses
codedescriptionhitsavg
200This response has no body.1901ms
400The request data does not match what we expect.3701ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.2843ms
413The request body is larger than what we accept. By default we only accept bodies of 100kB or less0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error13ms
Examples
Body: application/json
[ "feature-a", "feature-b" ]bulkToggleFeaturesSchema.features
Path Parameters
projectId1 / 1
#validinvalidschema
1831n/a{
2831n/a "type": "string"
3831n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
4158311ms
Path Parameters
projectId1 / 1
#validinvalidschema
1825n/a{
2825n/a "type": "string"
3825n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
4158251ms
Path Parameters
projectId1 / 1
#validinvalidschema
1817n/a{
2817n/a "type": "string"
3817n/a}
Responses
codedescriptionhitsavg
200projectFeaturesSchema7442ms
400The request data does not match what we expect.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error702ms
Path Parameters
projectId1 / 1
#validinvalidschema
11843n/a{
21843n/a "type": "string"
31843n/a}
Body
application/json22 / 22
createFeatureSchema
11327275{
21346223 "properties": {
373561 "description": {
4796n/a "nullable": true,
573561 "type": "string"
673561 },
767213 "impressionData": {
867213 "type": "boolean"
967213 },
10148664 "name": {
11148664 "type": "string"
12148664 },
13515159 "tags": {
14515138 "items": {
152001409 "$ref": "#/components/schemas/tagSchema"
16515138 },
1765321 "type": "array"
18515159 },
1963350 "type": {
2063350 "enum": [
2173n/a "experiment",
2280n/a "kill-switch",
23150n/a "release",
2485n/a "operational",
25160n/a "permission",
2685n/a "sunset"
2763350 ],
2863350 }
291346223 },
30155044 "required": [
31155044 "name"
32155044 ],
3315948 "type": "object"
341327275}
Referenced Components (1)14 of 14 keywords
tagSchema14 of 14 keywords
12001409{
2n/a0 "additionalProperties": false,
32023372 "properties": {
41102274 "color": {
51376n/a "nullable": true,
6479110 "pattern": "^#[0-9A-Fa-f]{6}$",
71212164 "type": "string"
81102274 },
9229777 "type": {
10233823 "maxLength": 50,
11232041 "minLength": 2,
12236113 "type": "string"
13229777 },
14233163 "value": {
15234445 "maxLength": 50,
16237613 "minLength": 2,
1723895 "type": "string"
18233163 }
192023372 },
20237322 "required": [
2123941 "value",
22237421 "type"
23237322 ],
24239515 "type": "object"
252001409}
Responses
codedescriptionhitsavg
200featureSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.152ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
201Created827ms
409Conflict5161ms
400Bad Request11581ms
500Internal Server Error663ms
Examples
Body: application/json
"Controls disabling of the comments section in case of an incident"createFeatureSchema.description
falsecreateFeatureSchema.impressionData
"disable-comments"createFeatureSchema.name
"#FFFFFF"tagSchema.color
"simple"tagSchema.type
"a-tag-value"tagSchema.value
"release"createFeatureSchema.type
Path Parameters
projectId1 / 1
#validinvalidschema
1535n/a{
2535n/a "type": "string"
3535n/a}
featureName1 / 1
1535n/a{
2535n/a "type": "string"
3535n/a}
Responses
codedescriptionhitsavg
202This response has no body.4584ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.741ms
Path Parameters
projectId1 / 1
#validinvalidschema
1867n/a{
2867n/a "type": "string"
3867n/a}
featureName1 / 1
1867n/a{
2867n/a "type": "string"
3867n/a}
Responses
codedescriptionhitsavg
200featureSchema4883ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.3762ms
Path Parameters
projectId1 / 1
#validinvalidschema
1936n/a{
2936n/a "type": "string"
3936n/a}
featureName1 / 1
1936n/a{
2936n/a "type": "string"
3936n/a}
Body
application/json9 / 9
patchesSchema
1477367{
2477336 "items": {
4477336 },
581331 "type": "array"
6477367}
Referenced Components (1)10 of 10 keywords
patchSchema10 of 10 keywords
124351241{
22527643 "properties": {
31387361 "from": {
41387361 "type": "string"
51387361 },
62923228 "op": {
72923228 "enum": [
8839n/a "add",
9327n/a "remove",
10431n/a "replace",
11421n/a "copy",
12512n/a "move",
13393n/a "test"
142923228 ],
1531465 "type": "string"
162923228 },
172688409 "path": {
182688409 "type": "string"
192688409 },
2034n/a "value": {
2134n/a }
222527643 },
23307893 "required": [
24309774 "path",
25315120 "op"
26307893 ],
273171505 "type": "object"
2824351241}
Responses
codedescriptionhitsavg
200featureSchema3124ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.402ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4471ms
500Internal Server Error1312ms
Examples
Body: application/json
"/type"patchSchema.from
"replace"patchSchema.op
"/type"patchSchema.path
"kill-switch"patchSchema.value
Path Parameters
projectId1 / 1
#validinvalidschema
1934n/a{
2934n/a "type": "string"
3934n/a}
featureName1 / 1
1934n/a{
2934n/a "type": "string"
3934n/a}
Body
application/json7 / 7
updateFeatureSchema
1590257{
2228218 "properties": {
321567 "archived": {
421567 "type": "boolean"
521567 },
619370 "description": {
719370 "type": "string"
819370 },
917962 "impressionData": {
1017962 "type": "boolean"
1117962 },
1218166 "stale": {
1318166 "type": "boolean"
1418166 },
15207111 "type": {
16207111 "enum": [
1717n/a "experiment",
1869n/a "kill-switch",
1927n/a "release",
2033n/a "operational",
2132n/a "permission",
2229n/a "sunset"
23207111 ],
24207111 }
25228218 },
2680839 "type": "object"
27590257}
Responses
codedescriptionhitsavg
200featureSchema5423ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.631ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3231ms
Examples
Body: application/json
trueupdateFeatureSchema.archived
"Controls disabling of the comments section in case of an incident"updateFeatureSchema.description
falseupdateFeatureSchema.impressionData
trueupdateFeatureSchema.stale
"kill-switch"updateFeatureSchema.type
Path Parameters
projectId1 / 1
#validinvalidschema
1888n/a{
2888n/a "type": "string"
3888n/a}
featureName1 / 1
1888n/a{
2888n/a "type": "string"
3888n/a}
Body
application/json5 / 5
cloneFeatureSchema
147868{
250014 "properties": {
34839 "name": {
44839 "type": "string"
54839 },
64759 "replaceGroupId": {
74759 "type": "boolean"
84759 }
950014 },
1049238 "required": [
1149238 "name"
1249238 ],
1353016 "type": "object"
1447868}
Responses
codedescriptionhitsavg
200featureSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.721ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
201Created119ms
409Conflict912ms
400Bad Request6151ms
500Internal Server Error1066ms
Examples
Body: application/json
"new-feature"cloneFeatureSchema.name
truecloneFeatureSchema.replaceGroupId
Path Parameters
projectId1 / 1
#validinvalidschema
1831n/a{
2831n/a "type": "string"
3831n/a}
featureName1 / 1
1831n/a{
2831n/a "type": "string"
3831n/a}
environment1 / 1
1831n/a{
2831n/a "type": "string"
3831n/a}
Responses
codedescriptionhitsavg
200featureEnvironmentSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.8311ms
Path Parameters
projectId1 / 1
#validinvalidschema
1820n/a{
2820n/a "type": "string"
3820n/a}
featureName1 / 1
1820n/a{
2820n/a "type": "string"
3820n/a}
environment1 / 1
1820n/a{
2820n/a "type": "string"
3820n/a}
Responses
codedescriptionhitsavg
200featureSchema0never seen
400The request data does not match what we expect.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.8202ms
Path Parameters
projectId1 / 1
#validinvalidschema
1815n/a{
2815n/a "type": "string"
3815n/a}
featureName1 / 1
1815n/a{
2815n/a "type": "string"
3815n/a}
environment1 / 1
1815n/a{
2815n/a "type": "string"
3815n/a}
Responses
codedescriptionhitsavg
200featureSchema0never seen
400The request data does not match what we expect.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.8152ms
Path Parameters
projectId1 / 1
#validinvalidschema
1837n/a{
2837n/a "type": "string"
3837n/a}
featureName1 / 1
1837n/a{
2837n/a "type": "string"
3837n/a}
environment1 / 1
1837n/a{
2837n/a "type": "string"
3837n/a}
Responses
codedescriptionhitsavg
200featureStrategySchema25ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.8321ms
Path Parameters
projectId1 / 1
#validinvalidschema
11047n/a{
21047n/a "type": "string"
31047n/a}
featureName1 / 1
11047n/a{
21047n/a "type": "string"
31047n/a}
environment1 / 1
11047n/a{
21047n/a "type": "string"
31047n/a}
Body
application/json46 / 46
createFeatureStrategySchema
1559268{
2572238 "properties": {
3324105 "constraints": {
432499 "items": {
632499 },
74236 "type": "array"
8324105 },
937016 "disabled": {
10386n/a "nullable": true,
1137016 "type": "boolean"
1237016 },
1378314 "name": {
1478314 "type": "string"
1578314 },
1636726 "parameters": {
18 "example": {
19 "groupId": "some_new",
20 "rollout": "25",
21 "stickiness": "sessionId"
22 }
2336726 },
2433431 "segments": {
2533420 "items": {
2699274 "type": "number"
2733420 },
2835411 "type": "array"
2933431 },
3037317 "sortOrder": {
3137317 "type": "number"
3237317 },
3335214 "title": {
34366n/a "nullable": true,
3535214 "type": "string"
3635214 },
3727187 "variants": {
3827181 "items": {
4027181 },
413526 "type": "array"
4227187 }
43572238 },
4479724 "required": [
4579724 "name"
4679724 ],
478216 "type": "object"
48559268}
Referenced Components (3)39 of 39 keywords
constraintSchema15 of 15 keywords
11132148{
2n/a0 "additionalProperties": false,
31161107 "properties": {
47195 "caseInsensitive": {
57195 "type": "boolean"
67195 },
7125013 "contextName": {
8125013 "type": "string"
9125013 },
1070719 "inverted": {
1170719 "type": "boolean"
1270719 },
13122519 "operator": {
14122519 "enum": [
1547n/a "NOT_IN",
16253n/a "IN",
1770n/a "STR_ENDS_WITH",
1846n/a "STR_STARTS_WITH",
1936n/a "STR_CONTAINS",
2028n/a "NUM_EQ",
2144n/a "NUM_GT",
2241n/a "NUM_GTE",
2376n/a "NUM_LT",
2475n/a "NUM_LTE",
2564n/a "DATE_AFTER",
2663n/a "DATE_BEFORE",
2766n/a "SEMVER_EQ",
2885n/a "SEMVER_GT",
2960n/a "SEMVER_LT",
3068n/a "SEMVER_GTE",
3149n/a "SEMVER_LTE",
3254n/a "REGEX"
33122519 ],
3412395 "type": "string"
35122519 },
3658930 "value": {
3758924 "minLength": 1,
386136 "type": "string"
3958930 },
4067221 "values": {
416725 "items": {
4227395 "type": "string"
436725 },
4467716 "type": "array"
4567221 }
461161107 },
47123929 "required": [
4812635 "contextName",
49124424 "operator"
50123929 ],
51126812 "type": "object"
521132148}
createStrategyVariantSchema22 of 22 keywords
1488223{
2493117 "properties": {
36045 "name": {
46045 "type": "string"
56045 },
627070 "payload": {
730419 "properties": {
82846 "type": {
92846 "enum": [
1096n/a "json",
1154n/a "csv",
1261n/a "string",
1373n/a "number"
142846 ],
152855 "type": "string"
162846 },
1730913 "value": {
1830913 "type": "string"
1930913 }
2030419 },
2128934 "required": [
2229033 "type",
233221 "value"
2428934 ],
2532317 "type": "object"
2627070 },
276035 "stickiness": {
286035 "type": "string"
296035 },
3056939 "weight": {
3158910 "maximum": 1000,
3258019 "minimum": 0,
3359810 "type": "integer"
3456939 },
3559414 "weightType": {
3659414 "enum": [
37269n/a "variable",
38325n/a "fix"
3959414 ],
406035 "type": "string"
4159414 }
42493117 },
436056 "required": [
446092 "name",
456083 "weight",
466083 "weightType",
476083 "stickiness"
486056 ],
49611100 "type": "object"
50488223}
parametersSchema2 of 2 keywords
136726{
212214 "additionalProperties": {
334344 "type": "string"
412214 },
538112 "type": "object"
636726}
Responses
codedescriptionhitsavg
200featureStrategySchema1186ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.1361ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
400Bad Request7611ms
500Internal Server Error262ms
Examples
Body: application/json
[ { "caseInsensitive": false, "contextName": "appName", "inverted": false, "operator": "IN", "values": [ "1", "2" ] } ]createFeatureStrategySchema.constraints
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
falsecreateFeatureStrategySchema.disabled
"flexibleRollout"createFeatureStrategySchema.name
[ 1, 2 ]createFeatureStrategySchema.segments
9999createFeatureStrategySchema.sortOrder
"Gradual Rollout 25-Prod"createFeatureStrategySchema.title
"blue_group"createStrategyVariantSchema.name
{ "type": "json", "value": "{\"color\": \"red\"}" }createStrategyVariantSchema.payload
"custom.context.field"createStrategyVariantSchema.stickiness
"fix"createStrategyVariantSchema.weightType
Path Parameters
projectId1 / 1
#validinvalidschema
1876n/a{
2876n/a "type": "string"
3876n/a}
featureName1 / 1
1876n/a{
2876n/a "type": "string"
3876n/a}
environment1 / 1
1876n/a{
2876n/a "type": "string"
3876n/a}
Body
application/json6 / 6
setStrategySortOrderSchema
1355348{
2355107 "items": {
3n/a0 "additionalProperties": false,
41137114 "properties": {
5111897 "id": {
6111897 "type": "string"
7111897 },
8114597 "sortOrder": {
9114597 "type": "number"
10114597 }
111137114 },
12120647 "required": [
13121538 "id",
14124211 "sortOrder"
15120647 ],
16125329 "type": "object"
17355107 },
18462241 "type": "array"
19355348}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
400The request data does not match what we expect.5021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
404Not Found3711ms
Examples
Body: application/json
"9c40958a-daac-400e-98fb-3bb438567008"setStrategySortOrderSchema.id
1setStrategySortOrderSchema.sortOrder
Path Parameters
projectId1 / 1
#validinvalidschema
1500n/a{
2500n/a "type": "string"
3500n/a}
featureName1 / 1
1500n/a{
2500n/a "type": "string"
3500n/a}
environment1 / 1
1500n/a{
2500n/a "type": "string"
3500n/a}
strategyId1 / 1
1500n/a{
2500n/a "type": "string"
3500n/a}
Responses
codedescriptionhitsavg
200This response has no body.1074ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation1801ms
404The requested resource was not found.2101ms
Path Parameters
projectId1 / 1
#validinvalidschema
1865n/a{
2865n/a "type": "string"
3865n/a}
featureName1 / 1
1865n/a{
2865n/a "type": "string"
3865n/a}
environment1 / 1
1865n/a{
2865n/a "type": "string"
3865n/a}
strategyId1 / 1
1865n/a{
2865n/a "type": "string"
3865n/a}
Responses
codedescriptionhitsavg
200featureStrategySchema4041ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation3521ms
404The requested resource was not found.1061ms
Path Parameters
projectId1 / 1
#validinvalidschema
1933n/a{
2933n/a "type": "string"
3933n/a}
featureName1 / 1
1933n/a{
2933n/a "type": "string"
3933n/a}
environment1 / 1
1933n/a{
2933n/a "type": "string"
3933n/a}
strategyId1 / 1
1933n/a{
2933n/a "type": "string"
3933n/a}
Body
application/json9 / 9
patchesSchema
1632184{
2632151 "items": {
4632151 },
578333 "type": "array"
6632184}
Referenced Components (1)10 of 10 keywords
patchSchema10 of 10 keywords
12454582{
22476507 "properties": {
31175312 "from": {
41175312 "type": "string"
51175312 },
62652326 "op": {
72652326 "enum": [
8552n/a "add",
9359n/a "remove",
10424n/a "replace",
11423n/a "copy",
12396n/a "move",
13498n/a "test"
142652326 ],
1529735 "type": "string"
162652326 },
172630336 "path": {
182630336 "type": "string"
192630336 },
2031n/a "value": {
2131n/a }
222476507 },
23296123 "required": [
24296618 "path",
2529786 "op"
26296123 ],
27298452 "type": "object"
282454582}
Responses
codedescriptionhitsavg
200featureStrategySchema875ms
400The request data does not match what we expect.4161ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation1512ms
404The requested resource was not found.2001ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error732ms
Examples
Body: application/json
"/type"patchSchema.from
"replace"patchSchema.op
"/type"patchSchema.path
"kill-switch"patchSchema.value
Path Parameters
projectId1 / 1
#validinvalidschema
11058n/a{
21058n/a "type": "string"
31058n/a}
featureName1 / 1
11058n/a{
21058n/a "type": "string"
31058n/a}
environment1 / 1
11058n/a{
21058n/a "type": "string"
31058n/a}
strategyId1 / 1
11058n/a{
21058n/a "type": "string"
31058n/a}
Body
application/json45 / 45
updateFeatureStrategySchema
1699259{
2291251 "properties": {
3308103 "constraints": {
430898 "items": {
630898 },
74065 "type": "array"
8308103 },
938015 "disabled": {
10395n/a "nullable": true,
1138015 "type": "boolean"
1238015 },
1334910 "name": {
1434910 "type": "string"
1534910 },
1634423 "parameters": {
1834423 },
1935425 "segments": {
2035415 "items": {
21137641 "type": "number"
2235415 },
2336910 "type": "array"
2435425 },
2540421 "sortOrder": {
2640421 "type": "number"
2740421 },
283459 "title": {
29354n/a "nullable": true,
303459 "type": "string"
313459 },
32272113 "variants": {
3327293 "items": {
3527293 },
3636520 "type": "array"
37272113 }
38291251 },
399508 "type": "object"
40699259}
Referenced Components (3)39 of 39 keywords
constraintSchema15 of 15 keywords
1621281{
2n/a0 "additionalProperties": false,
3649212 "properties": {
44595 "caseInsensitive": {
54595 "type": "boolean"
64595 },
778747 "contextName": {
878747 "type": "string"
978747 },
1041641 "inverted": {
1141641 "type": "boolean"
1241641 },
1377387 "operator": {
1477387 "enum": [
1545n/a "NOT_IN",
1679n/a "IN",
1738n/a "STR_ENDS_WITH",
1816n/a "STR_STARTS_WITH",
1962n/a "STR_CONTAINS",
2038n/a "NUM_EQ",
2163n/a "NUM_GT",
2246n/a "NUM_GTE",
2360n/a "NUM_LT",
2434n/a "NUM_LTE",
2519n/a "DATE_AFTER",
2635n/a "DATE_BEFORE",
2725n/a "SEMVER_EQ",
2856n/a "SEMVER_GT",
2941n/a "SEMVER_LT",
3033n/a "SEMVER_GTE",
3123n/a "SEMVER_LTE",
3260n/a "REGEX"
3377387 ],
348555 "type": "string"
3577387 },
364527 "value": {
374522 "minLength": 1,
384545 "type": "string"
394527 },
4046625 "values": {
4146617 "items": {
42214039 "type": "string"
4346617 },
444838 "type": "array"
4546625 }
46649212 },
4783329 "required": [
4883428 "contextName",
498602 "operator"
5083329 ],
5186240 "type": "object"
52621281}
parametersSchema2 of 2 keywords
134423{
21305 "additionalProperties": {
34135 "type": "string"
41305 },
534918 "type": "object"
634423}
strategyVariantSchema22 of 22 keywords
1508318{
2n/a0 "additionalProperties": false,
3512309 "properties": {
480416 "name": {
580416 "type": "string"
680416 },
737896 "payload": {
838385 "properties": {
94586 "type": {
104586 "enum": [
11155n/a "json",
1274n/a "csv",
13113n/a "string",
14116n/a "number"
154586 ],
164595 "type": "string"
174586 },
1838879 "value": {
1938879 "type": "string"
2038879 }
2138385 },
224635 "required": [
234644 "type",
244671 "value"
254635 ],
264686 "type": "object"
2737896 },
28678142 "stickiness": {
29678142 "type": "string"
30678142 },
3177248 "weight": {
327775 "maximum": 1000,
337784 "minimum": 0,
3478139 "type": "integer"
3577248 },
3681010 "weightType": {
3781010 "enum": [
38412n/a "variable",
39398n/a "fix"
4081010 ],
418155 "type": "string"
4281010 }
43512309 },
448174 "required": [
458201 "name",
468201 "weight",
478201 "weightType",
488201 "stickiness"
498174 ],
508215 "type": "object"
51508318}
Responses
codedescriptionhitsavg
200featureStrategySchema4404ms
400The request data does not match what we expect.3451ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation1072ms
404The requested resource was not found.1562ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error43ms
Examples
Body: application/json
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
falseupdateFeatureStrategySchema.disabled
[ 1, 2 ]updateFeatureStrategySchema.segments
"Gradual Rollout 25-Prod"updateFeatureStrategySchema.title
"blue_group"strategyVariantSchema.name
{ "type": "json", "value": "{\"color\": \"red\"}" }strategyVariantSchema.payload
"custom.context.field"strategyVariantSchema.stickiness
"fix"strategyVariantSchema.weightType
Path Parameters
projectId1 / 1
#validinvalidschema
1834n/a{
2834n/a "type": "string"
3834n/a}
featureName1 / 1
1834n/a{
2834n/a "type": "string"
3834n/a}
environment1 / 1
1834n/a{
2834n/a "type": "string"
3834n/a}
Responses
codedescriptionhitsavg
200featureVariantsSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.8341ms
Path Parameters
projectId1 / 1
#validinvalidschema
1875n/a{
2875n/a "type": "string"
3875n/a}
featureName1 / 1
1875n/a{
2875n/a "type": "string"
3875n/a}
environment1 / 1
1875n/a{
2875n/a "type": "string"
3875n/a}
Body
application/json9 / 9
patchesSchema
1378351{
2378328 "items": {
4378328 },
570623 "type": "array"
6378351}
Referenced Components (1)10 of 10 keywords
patchSchema10 of 10 keywords
117761118{
22059751 "properties": {
31070514 "from": {
41070514 "type": "string"
51070514 },
62499279 "op": {
72499279 "enum": [
8547n/a "add",
9364n/a "remove",
10351n/a "replace",
11437n/a "copy",
12397n/a "move",
13403n/a "test"
142499279 ],
1527735 "type": "string"
162499279 },
172397161 "path": {
182397161 "type": "string"
192397161 },
2032n/a "value": {
2132n/a }
222059751 },
232527286 "required": [
242558255 "path",
25277835 "op"
262527286 ],
27281381 "type": "object"
2817761118}
Responses
codedescriptionhitsavg
200featureVariantsSchema0never seen
400The request data does not match what we expect.4551ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation26ms
404The requested resource was not found.4151ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
Examples
Body: application/json
"/type"patchSchema.from
"replace"patchSchema.op
"/type"patchSchema.path
"kill-switch"patchSchema.value
Path Parameters
projectId1 / 1
#validinvalidschema
1921n/a{
2921n/a "type": "string"
3921n/a}
featureName1 / 1
1921n/a{
2921n/a "type": "string"
3921n/a}
environment1 / 1
1921n/a{
2921n/a "type": "string"
3921n/a}
Body
application/json26 / 26
variantsSchema
1431417{
2431389 "items": {
4431389 },
582028 "type": "array"
6431417}
Referenced Components (2)32 of 32 keywords
overrideSchema8 of 8 keywords
143842822{
2n/a0 "additionalProperties": false,
345182609 "properties": {
4702988 "contextName": {
5702988 "type": "string"
6702988 },
744702533 "values": {
844701299 "items": {
9223146797 "type": "string"
1044701299 },
1157691234 "type": "array"
1244702533 }
1345182609 },
146993134 "required": [
15711710 "contextName",
167003124 "values"
176993134 ],
18712779 "type": "object"
1943842822}
variantSchema24 of 24 keywords
113221283{
2n/a0 "additionalProperties": false,
313551202 "properties": {
42111423 "name": {
52111423 "type": "string"
62111423 },
71069541 "overrides": {
81069512 "items": {
101069512 },
11158129 "type": "array"
121069541 },
131032466 "payload": {
14n/a0 "additionalProperties": false,
151042414 "properties": {
161303145 "type": {
171303145 "enum": [
18365n/a "json",
19339n/a "csv",
20268n/a "string",
21331n/a "number"
221303145 ],
2314435 "type": "string"
241303145 },
251185269 "value": {
261185269 "type": "string"
271185269 }
281042414 },
29144614 "required": [
30144812 "type",
3114546 "value"
32144614 ],
33146038 "type": "object"
341032466 },
351216252 "stickiness": {
361216252 "type": "string"
371216252 },
382104443 "weight": {
39229765 "maximum": 1000,
402169193 "minimum": 0,
412362185 "type": "number"
422104443 },
431196130 "weightType": {
441196130 "enum": [
45628n/a "variable",
46568n/a "fix"
471196130 ],
4813215 "type": "string"
491196130 }
5013551202 },
51252439 "required": [
52253429 "name",
53254716 "weight"
54252439 ],
55256342 "type": "object"
5613221283}
Responses
codedescriptionhitsavg
200featureVariantsSchema0never seen
400The request data does not match what we expect.4441ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation3451ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
404Not Found1291ms
Examples
Body: application/json
"blue_group"variantSchema.name
"userId"overrideSchema.contextName
[ "red", "blue" ]overrideSchema.values
{ "type": "json", "value": "{\"color\": \"red\"}" }variantSchema.payload
"custom.context.field"variantSchema.stickiness
"variable"variantSchema.weightType
Path Parameters
projectId1 / 1
#validinvalidschema
1916n/a{
2916n/a "type": "string"
3916n/a}
featureName1 / 1
1916n/a{
2916n/a "type": "string"
3916n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
4159161ms
Path Parameters
projectId1 / 1
#validinvalidschema
1826n/a{
2826n/a "type": "string"
3826n/a}
featureName1 / 1
1826n/a{
2826n/a "type": "string"
3826n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
4158261ms
Path Parameters
projectId1 / 1
#validinvalidschema
1828n/a{
2828n/a "type": "string"
3828n/a}
featureName1 / 1
1828n/a{
2828n/a "type": "string"
3828n/a}
Responses
codedescriptionhitsavg
200featureLifecycleSchema8251ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
1857n/a{
2857n/a "type": "string"
3857n/a}
featureName1 / 1
1857n/a{
2857n/a "type": "string"
3857n/a}
Body
application/json6 / 6
featureLifecycleCompletedSchema
1357375{
2n/a0 "additionalProperties": false,
3373322 "properties": {
4494185 "status": {
5494185 "enum": [
6357n/a "kept",
7137n/a "discarded"
8494185 ],
96745 "type": "string"
10494185 },
11109270 "statusValue": {
12109270 "type": "string"
13109270 }
14373322 },
1567937 "required": [
1667937 "status"
1767937 ],
1871616 "type": "object"
19357375}
Responses
codedescriptionhitsavg
200This response has no body.4153ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4381ms
500Internal Server Error11ms
Examples
Body: application/json
"kept"featureLifecycleCompletedSchema.status
"variant1"featureLifecycleCompletedSchema.statusValue
Path Parameters
projectId1 / 1
#validinvalidschema
1820n/a{
2820n/a "type": "string"
3820n/a}
featureName1 / 1
1820n/a{
2820n/a "type": "string"
3820n/a}
Responses
codedescriptionhitsavg
200This response has no body.8173ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
1869n/a{
2869n/a "type": "string"
3869n/a}
featureName1 / 1
1869n/a{
2869n/a "type": "string"
3869n/a}
Body
application/json6 / 6
linkSchema
1395183{
2436106 "properties": {
323598 "title": {
4333n/a "nullable": true,
523598 "type": "string"
623598 },
742081 "url": {
842081 "type": "string"
942081 }
10436106 },
1150163 "required": [
1250163 "url"
1350163 ],
1456414 "type": "object"
15395183}
Responses
codedescriptionhitsavg
204This response has no body.594ms
400The request data does not match what we expect.4181ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation3131ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found731ms
Examples
Body: application/json
"Github cleanup"linkSchema.title
"https://github.com/search?q=cleanupReminder&type=code"linkSchema.url
Path Parameters
projectId1 / 1
#validinvalidschema
1952n/a{
2952n/a "type": "string"
3952n/a}
featureName1 / 1
1952n/a{
2952n/a "type": "string"
3952n/a}
Body
application/json30 / 30
pushVariantsSchema
1481337{
2229310 "properties": {
331765 "environments": {
431755 "items": {
5832387 "type": "string"
631755 },
737210 "type": "array"
831765 },
9200295 "variants": {
10200282 "items": {
12200282 },
1348213 "type": "array"
14200295 }
15229310 },
1679127 "type": "object"
17481337}
Referenced Components (2)32 of 32 keywords
overrideSchema8 of 8 keywords
137726493{
2n/a0 "additionalProperties": false,
337756485 "properties": {
446665592 "contextName": {
546665592 "type": "string"
646665592 },
79366893 "values": {
8936632 "items": {
946921122 "type": "string"
10936632 },
119398861 "type": "array"
129366893 }
1337756485 },
14102573 "required": [
15102582 "contextName",
16102591 "values"
17102573 ],
18102605 "type": "object"
1937726493}
variantSchema24 of 24 keywords
110471293{
2n/a0 "additionalProperties": false,
310621262 "properties": {
4225854 "name": {
5225854 "type": "string"
6225854 },
7709983 "overrides": {
8709934 "items": {
10709934 },
11164349 "type": "array"
12709983 },
13667915 "payload": {
14n/a0 "additionalProperties": false,
15733673 "properties": {
16135329 "type": {
17135329 "enum": [
18362n/a "json",
19459n/a "csv",
20200n/a "string",
21332n/a "number"
22135329 ],
2313775 "type": "string"
24135329 },
25720644 "value": {
26720644 "type": "string"
27720644 }
28733673 },
29134069 "required": [
30138227 "type",
31136445 "value"
32134069 ],
331409173 "type": "object"
34667915 },
35125048 "stickiness": {
36125048 "type": "string"
37125048 },
38222893 "weight": {
39227226 "maximum": 1000,
40225444 "minimum": 0,
41229823 "type": "number"
42222893 },
43102883 "weightType": {
44102883 "enum": [
45527n/a "variable",
46501n/a "fix"
47102883 ],
4811065 "type": "string"
49102883 }
5010621262 },
51230916 "required": [
52231213 "name",
5323214 "weight"
54230916 ],
55232515 "type": "object"
5610471293}
Responses
codedescriptionhitsavg
200featureVariantsSchema0never seen
400The request data does not match what we expect.8471ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
404Not Found942ms
500Internal Server Error84ms
Examples
Body: application/json
"blue_group"variantSchema.name
"userId"overrideSchema.contextName
[ "red", "blue" ]overrideSchema.values
{ "type": "json", "value": "{\"color\": \"red\"}" }variantSchema.payload
"custom.context.field"variantSchema.stickiness
"variable"variantSchema.weightType
Path Parameters
projectId1 / 1
#validinvalidschema
1876n/a{
2876n/a "type": "string"
3876n/a}
Body
application/json6 / 6
batchStaleSchema
1406385{
2452317 "properties": {
3430302 "features": {
4430214 "items": {
521011141 "type": "string"
6430214 },
764488 "type": "array"
8430302 },
9501259 "stale": {
10501259 "type": "boolean"
11501259 }
12452317 },
1372356 "required": [
1473247 "features",
1576019 "stale"
1672356 ],
1777912 "type": "object"
18406385}
Responses
codedescriptionhitsavg
202This response has no body.4631ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3891ms
500Internal Server Error181ms
Examples
Body: application/json
[ "my-feature-1", "my-feature-2", "my-feature-3" ]batchStaleSchema.features
"my-feature-5"batchStaleSchema.features
truebatchStaleSchema.stale
Frontend API 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200frontendApiFeaturesSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden8020ms
Body
application/json16 / 16
frontendApiFeaturesPostSchema
#validinvalidschema
1272186{
21n/a "additionalProperties": true,
3172168 "properties": {
4172168 "context": {
51n/a "additionalProperties": true,
6116153 "properties": {
714829 "appName": {
814820 "minLength": 1,
91689 "type": "string"
1014829 },
1115045 "currentTime": {
1215027 "format": "date-time",
1317718 "type": "string"
1415045 },
1515040 "environment": {
1615040 "type": "string"
1715040 },
1813450 "properties": {
1910423 "additionalProperties": {
2027873 "type": "string"
2110423 },
2215727 "type": "object"
2313450 },
2415718 "remoteAddress": {
2515718 "type": "string"
2615718 },
2717218 "sessionId": {
2817218 "type": "string"
2917218 },
3014716 "userId": {
3114716 "type": "string"
3214716 }
33116153 },
3432515 "type": "object"
35172168 }
36172168 },
3744018 "type": "object"
38272186}
Responses
codedescriptionhitsavg
200frontendApiFeaturesSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden4611ms
400Bad Request4131ms
Examples
Body: application/json
"My cool application."frontendApiFeaturesPostSchema.context.appName
"2022-07-05T12:56:41+02:00"frontendApiFeaturesPostSchema.context.currentTime
{ "customContextField": "this is one!", "otherCustomField": "3" }frontendApiFeaturesPostSchema.context
"192.168.1.1"frontendApiFeaturesPostSchema.context.remoteAddress
"b65e7b23-fec0-4814-a129-0e9861ef18fc"frontendApiFeaturesPostSchema.context.sessionId
"username@provider.com"frontendApiFeaturesPostSchema.context.userId
Body
application/json36 / 36
clientMetricsSchema
#validinvalidschema
1316214{
2323199 "properties": {
349619 "appName": {
449612 "minLength": 1,
55087 "type": "string"
649619 },
7213119 "bucket": {
8332n/a "nullable": true,
9148108 "properties": {
1021834 "start": {
12 "example": "1926-05-08T12:00:00.000Z"
1321834 },
1421834 "stop": {
16 "example": "1926-05-08T13:00:00.000Z"
1721834 },
1817976 "toggles": {
198567 "additionalProperties": {
20205132 "properties": {
2126429 "no": {
2226523 "minimum": 0,
232876 "type": "integer"
2426429 },
2515784 "variants": {
269251 "additionalProperties": {
272921 "minimum": 0,
28292182 "type": "integer"
299251 },
30241n/a "nullable": true,
3120833 "type": "object"
3215784 },
3323634 "yes": {
3423629 "minimum": 0,
352655 "type": "number"
3623634 }
37205132 },
383689 "type": "object"
398567 },
402469 "type": "object"
4117976 }
42148108 },
432508 "required": [
442526 "start",
452526 "stop",
462553 "toggles"
472508 ],
483284 "type": "object"
49213119 },
5027623 "instanceId": {
5127623 "type": "string"
5227623 },
532965 "platformName": {
542965 "type": "string"
552965 },
5627526 "platformVersion": {
5727526 "type": "string"
5827526 },
5928028 "sdkFlavor": {
6028012 "maxLength": 256,
6129216 "type": "string"
6228028 },
6327615 "sdkFlavorVersion": {
642766 "maxLength": 32,
652829 "type": "string"
6627615 },
6725710 "sdkVersion": {
6825710 "type": "string"
6925710 },
7025315 "specVersion": {
7125315 "type": "string"
7225315 },
7326811 "yggdrasilVersion": {
7426811 "type": "string"
7526811 }
76323199 },
7751510 "required": [
7851510 "appName"
7951510 ],
805255 "type": "object"
81316214}
Referenced Components (1)5 of 5 keywords
dateSchema5 of 5 keywords
143668{
243668 "oneOf": [
3131373 {
413128 "format": "date-time",
5159345 "type": "string"
6131373 },
7305199 {
8305199 "type": "integer"
9305199 }
1043668 ]
1143668}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
204This response has no body.0never seen
400The request data does not match what we expect.4261ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden5331ms
Examples
Body: application/json
"insurance-selector"clientMetricsSchema.appName
"2023-07-27T11:23:44Z"dateSchema
1690449593dateSchema
50clientMetricsSchema.bucket.toggles.no
{ "variantA": 15, "variantB": 25, "variantC": 5 }clientMetricsSchema.bucket.toggles.variants
974clientMetricsSchema.bucket.toggles.yes
{ "myCoolToggle": { "no": 42, "variants": { "blue": 6, "green": 15, "red": 46 }, "yes": 25 }, "myOtherToggle": { "no": 100, "yes": 0 } }clientMetricsSchema.bucket.toggles
"application-name-dacb1234"clientMetricsSchema.instanceId
".NET Core"clientMetricsSchema.platformName
"3.1"clientMetricsSchema.platformVersion
"unleash-openfeature-node-provider"clientMetricsSchema.sdkFlavor
"1.0.1"clientMetricsSchema.sdkFlavorVersion
"unleash-client-java:7.0.0"clientMetricsSchema.sdkVersion
"3.0.0"clientMetricsSchema.specVersion
"1.0.0"clientMetricsSchema.yggdrasilVersion
Body
application/json14 / 14
frontendApiClientSchema
#validinvalidschema
1226203{
2319105 "properties": {
331321 "appName": {
431321 "type": "string"
531321 },
619021 "environment": {
719021 "type": "string"
819021 },
918421 "instanceId": {
1018421 "type": "string"
1118421 },
1240716 "interval": {
1340716 "type": "number"
1440716 },
1519321 "sdkVersion": {
1619321 "type": "string"
1719321 },
1838736 "started": {
1938736 "oneOf": [
20245178 {
212458 "format": "date-time",
22253170 "type": "string"
23245178 },
24142281 {
25142281 "type": "number"
26142281 }
2738736 ]
2838736 },
2939033 "strategies": {
3039015 "items": {
31144621 "type": "string"
3239015 },
3340518 "type": "array"
3439033 }
35319105 },
3633193 "required": [
3733490 "appName",
384231 "interval",
394231 "started",
404231 "strategies"
4133193 ],
424245 "type": "object"
43226203}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
400The request data does not match what we expect.4301ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden4321ms
Examples
Body: application/json
"development"frontendApiClientSchema.environment
Import/Export 3 operations 2 covered 1 partial 0 uncovered 0 not measured 97% #
Body
application/json19 / 19
exportQuerySchema
#validinvalidschema
11348467{
21404411 "anyOf": [
35531262 {
41419275 "properties": {
5692165 "downloadFile": {
6692165 "type": "boolean"
7692165 },
81486171 "environment": {
91486171 "type": "string"
101486171 },
11535113 "features": {
1253566 "items": {
131982116 "minLength": 1,
142098158 "type": "string"
1553566 },
1660147 "type": "array"
17535113 }
181419275 },
196331126 "required": [
201657102 "environment",
216481111 "features"
226331126 ]
235531262 },
244321383 {
251445242 "properties": {
26692165 "downloadFile": {
27692165 "type": "boolean"
28692165 },
291486171 "environment": {
301486171 "type": "string"
311486171 },
3240626 "tag": {
3340626 "type": "string"
3440626 }
351445242 },
364231336 "required": [
371657102 "environment",
384321327 "tag"
394231336 ]
404321383 },
415311284 {
421448240 "properties": {
43692165 "downloadFile": {
44692165 "type": "boolean"
45692165 },
461486171 "environment": {
471486171 "type": "string"
481486171 },
4952144 "project": {
5052144 "type": "string"
5152144 }
521448240 },
535591200 "required": [
541657102 "environment",
555651194 "project"
565591200 ]
575311284 }
581404411 ],
59175956 "type": "object"
601348467}
Responses
codedescriptionhitsavg
200exportResultSchema13865ms
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
41531ms
400Bad Request5031ms
500Internal Server Error231ms
Examples
Body: application/json
trueexportQuerySchema.downloadFile
"development"exportQuerySchema.environment
[ "MyAwesomeFeature" ]exportQuerySchema.features
trueexportQuerySchema.downloadFile
"development"exportQuerySchema.environment
"release"exportQuerySchema.tag
trueexportQuerySchema.downloadFile
"development"exportQuerySchema.environment
"my-project"exportQuerySchema.project
Body
application/json422 / 422
importTogglesSchema
#validinvalidschema
19322551{
2n/a0 "additionalProperties": false,
39452529 "properties": {
49542519 "data": {
69542519 },
7345013 "environment": {
8345013 "type": "string"
9345013 },
1034675 "project": {
1134675 "type": "string"
1234675 }
139452529 },
14346117 "required": [
1534726 "project",
16346315 "environment",
1734735 "data"
18346117 ],
1934785 "type": "object"
209322551}
Referenced Components (25)508 of 508 keywords
constraintSchema15 of 15 keywords
13761328{
2n/a0 "additionalProperties": false,
33773291 "properties": {
4213325 "caseInsensitive": {
5213325 "type": "boolean"
6213325 },
7403225 "contextName": {
8403225 "type": "string"
9403225 },
10219925 "inverted": {
11219925 "type": "boolean"
12219925 },
13402534 "operator": {
14402534 "enum": [
15205n/a "NOT_IN",
16759n/a "IN",
17183n/a "STR_ENDS_WITH",
18180n/a "STR_STARTS_WITH",
19168n/a "STR_CONTAINS",
20164n/a "NUM_EQ",
21224n/a "NUM_GT",
22147n/a "NUM_GTE",
23159n/a "NUM_LT",
24182n/a "NUM_LTE",
25188n/a "DATE_AFTER",
26147n/a "DATE_BEFORE",
27258n/a "SEMVER_EQ",
28199n/a "SEMVER_GT",
29238n/a "SEMVER_LT",
30174n/a "SEMVER_GTE",
31236n/a "SEMVER_LTE",
32214n/a "REGEX"
33402534 ],
34403425 "type": "string"
35402534 },
36192834 "value": {
3719289 "minLength": 1,
38193725 "type": "string"
39192834 },
402113148 "values": {
41211371 "items": {
429154160 "type": "string"
43211371 },
44218477 "type": "array"
452113148 }
463773291 },
47405212 "required": [
4840577 "contextName",
4940595 "operator"
50405212 ],
51406425 "type": "object"
523761328}
contextFieldSchema22 of 22 keywords
1320970{
2n/a0 "additionalProperties": false,
3321064 "properties": {
41546 "createdAt": {
5942 "format": "date-time",
6160n/a "nullable": true,
71564 "type": "string"
81546 },
931514 "description": {
103155n/a "nullable": true,
1131514 "type": "string"
1231514 },
13314021 "legalValues": {
14314016 "items": {
16314016 },
1731565 "type": "array"
18314021 },
1932685 "name": {
2032685 "type": "string"
2132685 },
221385 "project": {
231385 "type": "string"
241385 },
2531496 "sortOrder": {
2631496 "type": "integer"
2731496 },
2831395 "stickiness": {
2931395 "type": "boolean"
3031395 },
311526 "usedInFeatures": {
321221 "minimum": 0,
33158n/a "nullable": true,
341535 "type": "integer"
351526 },
361516 "usedInProjects": {
371121 "minimum": 0,
38157n/a "nullable": true,
391525 "type": "integer"
401516 }
41321064 },
4232731 "required": [
4332731 "name"
4432731 ],
4532745 "type": "object"
46320970}
createStrategyVariantSchema22 of 22 keywords
184102{
29284 "properties": {
316410 "name": {
416410 "type": "string"
516410 },
611336 "payload": {
711722 "properties": {
812512 "type": {
912512 "enum": [
1094n/a "json",
117n/a "csv",
122n/a "string",
1322n/a "number"
1412512 ],
1512710 "type": "string"
1612512 },
1712710 "value": {
1812710 "type": "string"
1912710 }
2011722 },
211354 "required": [
221372 "type",
231372 "value"
241354 ],
2513910 "type": "object"
2611336 },
2716410 "stickiness": {
2816410 "type": "string"
2916410 },
3015816 "weight": {
311622 "maximum": 1000,
321622 "minimum": 0,
3316212 "type": "integer"
3415816 },
3516212 "weightType": {
3616212 "enum": [
3738n/a "variable",
38124n/a "fix"
3916212 ],
4016410 "type": "string"
4116212 }
429284 },
431688 "required": [
441742 "name",
451742 "weight",
461742 "weightType",
471742 "stickiness"
481688 ],
4917610 "type": "object"
5084102}
dependentFeatureSchema9 of 9 keywords
133562{
2n/a0 "additionalProperties": false,
333620 "properties": {
41835 "enabled": {
51835 "type": "boolean"
61835 },
73505 "feature": {
83505 "type": "string"
93505 },
1017810 "variants": {
111785 "items": {
128715 "type": "string"
131785 },
141835 "type": "array"
1517810 }
1633620 },
173551 "required": [
183551 "feature"
193551 ],
2035641 "type": "object"
2133562}
exportResultSchema29 of 29 keywords
19542519{
2n/a0 "additionalProperties": false,
39572511 "properties": {
4315675 "contextFields": {
5315670 "items": {
7315670 },
832265 "type": "array"
9315675 },
10316349 "dependencies": {
11316344 "items": {
13316344 },
1432075 "type": "array"
15316349 },
162321915 "featureEnvironments": {
172321910 "items": {
192321910 },
2032315 "type": "array"
212321915 },
223265202 "featureStrategies": {
233265197 "items": {
253265197 },
2634625 "type": "array"
273265202 },
28317731 "featureTags": {
29317726 "items": {
31317726 },
3232035 "type": "array"
33317731 },
3422981169 "features": {
3522981164 "items": {
3722981164 },
3834625 "type": "array"
3922981169 },
40316339 "links": {
41316334 "items": {
43316334 },
4431975 "type": "array"
45316339 },
46318422 "segments": {
47318417 "items": {
48n/a0 "additionalProperties": false,
49328210 "properties": {
5032865 "id": {
5132865 "type": "number"
5232865 },
5332865 "name": {
5432865 "type": "string"
5532865 }
56328210 },
5732902 "required": [
5832911 "id",
5932911 "name"
6032902 ],
6132925 "type": "object"
62318417 },
6332015 "type": "array"
64318422 },
65343136 "tagTypes": {
66343131 "items": {
68343131 },
6934625 "type": "array"
70343136 }
719572511 },
7234653 "required": [
7334671 "features",
7434671 "featureStrategies",
7534671 "tagTypes"
7634653 ],
7734685 "type": "object"
789542519}
featureDependenciesSchema8 of 8 keywords
112253{
2n/a0 "additionalProperties": false,
312446 "properties": {
412841 "dependencies": {
512836 "items": {
712836 },
81645 "type": "array"
912841 },
101645 "feature": {
111645 "type": "string"
121645 }
1312446 },
141682 "required": [
151691 "feature",
161691 "dependencies"
171682 ],
181705 "type": "object"
1912253}
featureEnvironmentSafeguardSchema35 of 35 keywords
1264228{
2n/a0 "additionalProperties": false,
3272210 "properties": {
442258 "action": {
5n/a0 "additionalProperties": false,
643040 "properties": {
745810 "environment": {
845810 "type": "string"
945810 },
1045810 "featureName": {
1145810 "type": "string"
1245810 },
1345810 "project": {
1445810 "type": "string"
1545810 },
1645810 "type": {
1745810 "type": "string"
1845810 }
1943040 },
204628 "required": [
214682 "type",
224682 "featureName",
234682 "environment",
244682 "project"
254628 ],
2647010 "type": "object"
2742258 },
2847010 "id": {
2947010 "type": "string"
3047010 },
31374106 "impactMetric": {
32n/a0 "additionalProperties": false,
3338486 "properties": {
3445612 "aggregationMode": {
3545612 "enum": [
36247n/a "rps",
3739n/a "count",
3850n/a "avg",
3934n/a "sum",
4022n/a "p95",
4136n/a "p99",
4228n/a "p50"
4345612 ],
4445810 "type": "string"
4545612 },
4645810 "id": {
4745810 "type": "string"
4845810 },
4943830 "labelSelectors": {
5035320 "additionalProperties": {
5192510 "items": {
52284310 "type": "string"
5392510 },
5493510 "type": "array"
5535320 },
5645810 "type": "object"
5743830 },
5845810 "metricName": {
5945810 "type": "string"
6045810 },
6134012 "source": {
6234012 "enum": [
63283n/a "internal",
6457n/a "external"
6534012 ],
6634210 "type": "string"
6734012 },
6845612 "timeRange": {
6945612 "enum": [
7073n/a "hour",
71264n/a "day",
7261n/a "week",
7358n/a "month"
7445612 ],
7545810 "type": "string"
7645612 }
7738486 },
7846010 "required": [
794682 "id",
804682 "metricName",
814682 "timeRange",
824682 "aggregationMode",
834682 "labelSelectors"
8446010 ],
8547010 "type": "object"
86374106 },
8744436 "triggerCondition": {
8944436 }
90272210 },
914748 "required": [
924802 "id",
934802 "action",
944802 "triggerCondition",
954802 "impactMetric"
964748 ],
9748210 "type": "object"
98264228}
featureEnvironmentSchema34 of 34 keywords
127161891{
2n/a0 "additionalProperties": false,
327201877 "properties": {
4222820 "changeRequestIds": {
5222810 "items": {
620010 "type": "number"
7222810 },
8223810 "type": "array"
9222820 },
10458510 "enabled": {
11458510 "type": "boolean"
12458510 },
13418910 "environment": {
14418910 "type": "string"
15418910 },
16419910 "featureName": {
17419910 "type": "string"
18419910 },
19223410 "hasEnabledStrategies": {
20223410 "type": "boolean"
21223410 },
22222010 "hasStrategies": {
23222010 "type": "boolean"
24222010 },
25218283 "lastSeenAt": {
2621644 "format": "date-time",
272265n/a "nullable": true,
28218679 "type": "string"
29218283 },
30220110 "milestoneName": {
31220110 "type": "string"
32220110 },
33220910 "milestoneOrder": {
34220910 "type": "number"
35220910 },
36458510 "name": {
37458510 "type": "string"
38458510 },
39220714 "no": {
4022092 "minimum": 0,
41220912 "type": "integer"
42220714 },
431380888 "releasePlans": {
441380861 "items": {
461380861 },
47224127 "type": "array"
481380888 },
491985238 "safeguards": {
501985228 "items": {
521985228 },
53221310 "type": "array"
541985238 },
55218410 "sortOrder": {
56218410 "type": "number"
57218410 },
581878383 "strategies": {
591878373 "items": {
611878373 },
62225110 "type": "array"
631878383 },
64218410 "totalMilestones": {
65218410 "type": "number"
66218410 },
67217110 "type": {
68217110 "type": "string"
69217110 },
70219510 "variantCount": {
71219510 "type": "number"
72219510 },
734006187 "variants": {
744006177 "items": {
764006177 },
77418310 "type": "array"
784006187 },
79215214 "yes": {
8021542 "minimum": 0,
81215412 "type": "integer"
82215214 }
8327201877 },
8445934 "required": [
8545952 "name",
8645952 "enabled"
8745934 ],
88459710 "type": "object"
8927161891}
featureLinksSchema8 of 8 keywords
19134{
2n/a0 "additionalProperties": false,
39327 "properties": {
41145 "feature": {
51145 "type": "string"
61145 },
79722 "links": {
89717 "items": {
109717 },
111145 "type": "array"
129722 }
139327 },
141182 "required": [
151191 "feature",
161191 "links"
171182 ],
181205 "type": "object"
199134}
featureSchema83 of 83 keywords
124641181{
2n/a0 "additionalProperties": false,
324701156 "properties": {
432265 "archived": {
532265 "type": "boolean"
632265 },
715296 "archivedAt": {
814642 "format": "date-time",
91535n/a "nullable": true,
1015314 "type": "string"
1115296 },
12151810 "children": {
1315185 "items": {
145965 "type": "string"
1515185 },
1615235 "type": "array"
17151810 },
18148735 "collaborators": {
19148729 "properties": {
20148729 "users": {
21148724 "items": {
2257416 "properties": {
235836 "id": {
245836 "type": "integer"
255836 },
265845 "imageUrl": {
275845 "type": "string"
285845 },
295845 "name": {
305845 "type": "string"
315845 }
3257416 },
335873 "required": [
345891 "id",
355891 "name",
365891 "imageUrl"
375873 ],
385905 "type": "object"
39148724 },
4015115 "type": "array"
41148729 }
42148729 },
4315161 "required": [
4415161 "users"
4515161 ],
4615175 "type": "object"
47148735 },
4815356 "createdAt": {
4914602 "format": "date-time",
501541n/a "nullable": true,
5115374 "type": "string"
5215356 },
53149225 "createdBy": {
54n/a0 "additionalProperties": false,
55149616 "properties": {
5615046 "id": {
5715046 "type": "integer"
5815046 },
5915065 "imageUrl": {
6015065 "type": "string"
6115065 },
6215065 "name": {
6315065 "type": "string"
6415065 }
65149616 },
6615084 "required": [
6715102 "id",
6815111 "name",
6915111 "imageUrl"
7015084 ],
7115125 "type": "object"
72149225 },
73146632 "dependencies": {
74146627 "items": {
75n/a0 "additionalProperties": false,
7635123 "properties": {
771855 "enabled": {
781855 "type": "boolean"
791855 },
803685 "feature": {
813685 "type": "string"
823685 },
8319513 "variants": {
841955 "items": {
858645 "type": "string"
861955 },
872008 "type": "array"
8819513 }
8935123 },
903731 "required": [
913731 "feature"
923731 ],
933745 "type": "object"
94146627 },
9514935 "type": "array"
96146632 },
9731734 "description": {
983177n/a "nullable": true,
9931734 "type": "string"
10031734 },
10115265 "enabled": {
10215265 "type": "boolean"
10315265 },
104597907 "environments": {
105597902 "items": {
107597902 },
10814995 "type": "array"
109597907 },
11015065 "favorite": {
11115065 "type": "boolean"
11215065 },
11331525 "impressionData": {
11431525 "type": "boolean"
11531525 },
116149424 "lifecycle": {
117n/a0 "additionalProperties": false,
118149617 "properties": {
11915066 "enteredStageAt": {
12015061 "format": "date-time",
12115075 "type": "string"
12215066 },
12315057 "stage": {
12415057 "enum": [
1251409n/a "initial",
12635n/a "pre-live",
12729n/a "live",
12818n/a "completed",
12914n/a "archived"
13015057 ],
13115075 "type": "string"
13215057 },
13314254 "status": {
1341429n/a "nullable": true,
13514254 "type": "string"
13614254 }
137149617 },
13815112 "required": [
13915121 "stage",
14015121 "enteredStageAt"
14115112 ],
14215135 "type": "object"
143149424 },
144148535 "links": {
145148530 "items": {
146n/a0 "additionalProperties": false,
14737219 "properties": {
1481985 "feature": {
1491985 "type": "string"
1501985 },
1513815 "id": {
1523815 "type": "string"
1533815 },
1542104 "title": {
155214n/a "nullable": true,
1562104 "type": "string"
1572104 },
1583855 "url": {
1593855 "type": "string"
1603855 }
16137219 },
1623856 "required": [
1633865 "id",
1643901 "url"
1653856 ],
1663915 "type": "object"
167148530 },
16815155 "type": "array"
169148535 },
17036155 "name": {
17136155 "type": "string"
17236155 },
17331455 "project": {
17431455 "type": "string"
17531455 },
17631465 "stale": {
17731465 "type": "boolean"
17831465 },
179146132 "tags": {
180142228 "items": {
182142228 },
1831493n/a "nullable": true,
18414894 "type": "array"
185146132 },
18631465 "type": {
18731465 "type": "string"
18831465 }
18924701156 },
190362020 "required": [
191362020 "name"
192362020 ],
19336405 "type": "object"
19424641181}
featureStrategySchema20 of 20 keywords
14425623{
2n/a0 "additionalProperties": false,
34440593 "properties": {
43995193 "constraints": {
53995178 "items": {
73995178 },
8417315 "type": "array"
93995193 },
10415712 "disabled": {
114169n/a "nullable": true,
12415712 "type": "boolean"
13415712 },
14418015 "featureName": {
15418015 "type": "string"
16418015 },
17410475 "id": {
18410475 "type": "string"
19410475 },
20500315 "name": {
21500315 "type": "string"
22500315 },
23412730 "parameters": {
25412730 },
26414330 "segments": {
27414315 "items": {
28719615 "type": "number"
29414315 },
30415815 "type": "array"
31414330 },
32126215 "sortOrder": {
33126215 "type": "number"
34126215 },
35416048 "title": {
364208n/a "nullable": true,
37416048 "type": "string"
38416048 },
391053196 "variants": {
401053181 "items": {
421053181 },
43123415 "type": "array"
441053196 }
454440593 },
46501815 "required": [
47501815 "name"
48501815 ],
49503315 "type": "object"
504425623}
featureTagSchema10 of 10 keywords
1319326{
2n/a0 "additionalProperties": false,
3319519 "properties": {
4754 "createdByUserId": {
579n/a "nullable": true,
6754 "type": "number"
7754 },
832085 "featureName": {
932085 "type": "string"
1032085 },
1131335 "tagType": {
1231335 "type": "string"
1331335 },
1432085 "tagValue": {
1532085 "type": "string"
1632085 }
17319519 },
1832122 "required": [
1932131 "featureName",
2032131 "tagValue"
2132122 ],
2232145 "type": "object"
23319326}
legalValueSchema7 of 7 keywords
143316{
2n/a0 "additionalProperties": false,
343410 "properties": {
42385 "description": {
52385 "type": "string"
62385 },
74385 "value": {
84385 "type": "string"
94385 }
1043410 },
114431 "required": [
124431 "value"
134431 ],
144445 "type": "object"
1543316}
linkSchema8 of 8 keywords
139117{
23949 "properties": {
31764 "title": {
4180n/a "nullable": true,
51764 "type": "string"
61764 },
73955 "url": {
83955 "type": "string"
93955 }
103949 },
114003 "required": [
124003 "url"
134003 ],
144035 "type": "object"
1539117}
overrideSchema8 of 8 keywords
151144{
2n/a0 "additionalProperties": false,
351530 "properties": {
453310 "contextName": {
553310 "type": "string"
653310 },
752320 "values": {
852310 "items": {
9278810 "type": "string"
1052310 },
1153310 "type": "array"
1252320 }
1351530 },
145414 "required": [
155432 "contextName",
165432 "values"
175414 ],
1854510 "type": "object"
1951144}
parametersSchema2 of 2 keywords
1457450{
2342725 "additionalProperties": {
31030625 "type": "string"
4342725 },
5459925 "type": "object"
6457450}
releasePlanMilestoneSchema23 of 23 keywords
1240565{
2n/a0 "additionalProperties": false,
3248547 "properties": {
478310 "id": {
57912 "nullable": false,
678310 "type": "string"
778310 },
878310 "name": {
978310 "type": "string"
1078310 },
1163112 "pausedAt": {
126164 "format": "date-time",
13643n/a "nullable": true,
146358 "type": "string"
1563112 },
1662412 "progressionExecutedAt": {
176034 "format": "date-time",
18636n/a "nullable": true,
196288 "type": "string"
2062412 },
2178310 "releasePlanDefinitionId": {
2278310 "type": "string"
2378310 },
2478112 "sortOrder": {
2578112 "type": "integer"
2678112 },
2760512 "startedAt": {
285744 "format": "date-time",
29617n/a "nullable": true,
306098 "type": "string"
3160512 },
32264461 "strategies": {
33264451 "items": {
35264451 },
3671510 "type": "array"
37264461 },
386078 "transitionCondition": {
39615n/a "nullable": true,
406078 "type": "object"
416078 }
42248547 },
437878 "required": [
447932 "id",
457932 "name",
467932 "sortOrder",
477932 "releasePlanDefinitionId"
487878 ],
4979510 "type": "object"
50240565}
releasePlanMilestoneStrategySchema22 of 22 keywords
1160510{
2n/a0 "additionalProperties": false,
3188436 "properties": {
4382127 "constraints": {
5382117 "items": {
7382117 },
849910 "type": "array"
9382127 },
10447104 "disabled": {
11551n/a "nullable": true,
12447104 "type": "boolean"
13447104 },
1460010 "id": {
156082 "nullable": false,
1660010 "type": "string"
1760010 },
1860610 "milestoneId": {
1960610 "type": "string"
2060610 },
2159410 "name": {
2259410 "type": "string"
2359410 },
2444720 "parameters": {
26 "example": {
27 "groupId": "some_new",
28 "rollout": "25",
29 "stickiness": "sessionId"
30 }
3144720 },
3244120 "segments": {
3344110 "items": {
3493410 "type": "number"
3544110 },
3645110 "type": "array"
3744120 },
3859410 "sortOrder": {
3959410 "type": "number"
4059410 },
4159410 "strategyName": {
4259410 "type": "string"
4359410 },
444408 "title": {
45448n/a "nullable": true,
464408 "type": "string"
474408 },
48339112 "variants": {
49339102 "items": {
51339102 },
5244110 "type": "array"
53339112 }
54188436 },
5559664 "required": [
5661050 "id",
5761644 "milestoneId",
5860456 "sortOrder",
5960456 "name",
6060456 "strategyName"
6159664 ],
6266010 "type": "object"
63160510}
releasePlanSafeguardSchema33 of 33 keywords
189204{
2n/a0 "additionalProperties": false,
397186 "properties": {
424734 "action": {
5n/a0 "additionalProperties": false,
625120 "properties": {
725910 "id": {
825910 "type": "string"
925910 },
1025910 "type": {
1125910 "type": "string"
1225910 }
1325120 },
142674 "required": [
152692 "type",
162692 "id"
172674 ],
1827110 "type": "object"
1924734 },
2027110 "id": {
2127110 "type": "string"
2227110 },
23175106 "impactMetric": {
24n/a0 "additionalProperties": false,
2518586 "properties": {
2625712 "aggregationMode": {
2725712 "enum": [
28195n/a "rps",
2915n/a "count",
3014n/a "avg",
317n/a "sum",
329n/a "p95",
339n/a "p99",
348n/a "p50"
3525712 ],
3625910 "type": "string"
3725712 },
3825910 "id": {
3925910 "type": "string"
4025910 },
4123930 "labelSelectors": {
4221520 "additionalProperties": {
4351410 "items": {
4495110 "type": "string"
4551410 },
4652410 "type": "array"
4721520 },
4825910 "type": "object"
4923930 },
5025910 "metricName": {
5125910 "type": "string"
5225910 },
5322912 "source": {
5422912 "enum": [
55213n/a "internal",
5616n/a "external"
5722912 ],
5823110 "type": "string"
5922912 },
6025712 "timeRange": {
6125712 "enum": [
6214n/a "hour",
63216n/a "day",
649n/a "week",
6518n/a "month"
6625712 ],
6725910 "type": "string"
6825712 }
6918586 },
7026110 "required": [
712692 "id",
722692 "metricName",
732692 "timeRange",
742692 "aggregationMode",
752692 "labelSelectors"
7626110 ],
7727110 "type": "object"
78175106 },
7924536 "triggerCondition": {
8124536 }
8297186 },
832758 "required": [
842812 "id",
852812 "action",
862812 "triggerCondition",
872812 "impactMetric"
882758 ],
8928310 "type": "object"
9089204}
releasePlanSchema29 of 29 keywords
1234894{
2n/a0 "additionalProperties": false,
3252866 "properties": {
410068 "activeMilestoneId": {
51014n/a "nullable": true,
610068 "type": "string"
710068 },
8110412 "createdAt": {
911042 "format": "date-time",
1011142 "nullable": false,
11110610 "type": "string"
12110412 },
13110610 "createdByUserId": {
1411142 "nullable": false,
15110610 "type": "number"
16110610 },
179898 "description": {
18997n/a "nullable": true,
199898 "type": "string"
209898 },
21110412 "discriminator": {
22110412 "enum": [
231104n/a "plan"
24110412 ],
2511142 "nullable": false,
26110610 "type": "string"
27110412 },
28110610 "environment": {
29110610 "type": "string"
30110610 },
31110610 "featureName": {
32110610 "type": "string"
33110610 },
34110610 "id": {
3511142 "nullable": false,
36110610 "type": "string"
37110610 },
38564552 "milestones": {
39564542 "items": {
41564542 },
42110610 "type": "array"
43564552 },
44110610 "name": {
45110610 "type": "string"
46110610 },
47110610 "releasePlanTemplateId": {
4811142 "nullable": false,
49110610 "type": "string"
50110610 },
51787214 "safeguards": {
52787204 "items": {
54787204 },
5599110 "type": "array"
56787214 }
57252866 },
58110018 "required": [
5911162 "id",
6011162 "discriminator",
6111162 "name",
6211162 "featureName",
6311162 "environment",
6411162 "createdByUserId",
6511162 "createdAt",
6611162 "milestones",
6711162 "releasePlanTemplateId"
68110018 ],
69111810 "type": "object"
70234894}
safeguardTriggerConditionSchema9 of 9 keywords
168972{
2n/a0 "additionalProperties": false,
369744 "properties": {
471324 "operator": {
571324 "enum": [
6573n/a ">",
7140n/a "<"
871324 ],
971720 "type": "string"
1071324 },
1171720 "threshold": {
1271720 "type": "number"
1371720 }
1469744 },
157338 "required": [
167374 "operator",
177374 "threshold"
187338 ],
1974120 "type": "object"
2068972}
strategyVariantSchema22 of 22 keywords
12505187{
2n/a0 "additionalProperties": false,
32517160 "properties": {
4265915 "name": {
5265915 "type": "string"
6265915 },
7125278 "payload": {
8125857 "properties": {
9127042 "type": {
10127042 "enum": [
11387n/a "json",
12281n/a "csv",
13262n/a "string",
14340n/a "number"
15127042 ],
16129715 "type": "string"
17127042 },
18129715 "value": {
19129715 "type": "string"
20129715 }
21125857 },
2213096 "required": [
2313123 "type",
2413123 "value"
2513096 ],
26131515 "type": "object"
27125278 },
28265915 "stickiness": {
29265915 "type": "string"
30265915 },
31264430 "weight": {
3226509 "maximum": 1000,
3326563 "minimum": 0,
34265618 "type": "integer"
35264430 },
36265222 "weightType": {
37265222 "enum": [
381246n/a "variable",
391406n/a "fix"
40265222 ],
41265915 "type": "string"
42265222 }
432517160 },
44266512 "required": [
4526743 "name",
4626743 "weight",
4726743 "weightType",
4826743 "stickiness"
49266512 ],
50267715 "type": "object"
512505187}
tagSchema14 of 14 keywords
115429{
2n/a0 "additionalProperties": false,
315620 "properties": {
4976 "color": {
5103n/a "nullable": true,
6722 "pattern": "^#[0-9A-Fa-f]{6}$",
7994 "type": "string"
8976 },
91687 "type": {
101691 "maxLength": 50,
111691 "minLength": 2,
121705 "type": "string"
131687 },
141687 "value": {
151691 "maxLength": 50,
161691 "minLength": 2,
171705 "type": "string"
181687 }
1915620 },
201742 "required": [
211751 "value",
221751 "type"
231742 ],
241767 "type": "object"
2515429}
tagTypeSchema12 of 12 keywords
1381331{
2n/a0 "additionalProperties": false,
3381520 "properties": {
43376 "color": {
5343n/a "nullable": true,
61742 "pattern": "^#[0-9A-Fa-f]{6}$",
73394 "type": "string"
83376 },
934435 "description": {
1034435 "type": "string"
1134435 },
1234564 "icon": {
133460n/a "nullable": true,
1434564 "type": "string"
1534564 },
1638285 "name": {
1738285 "type": "string"
1838285 }
19381520 },
2038336 "required": [
2138336 "name"
2238336 ],
2338395 "type": "object"
24381331}
variantSchema24 of 24 keywords
14207194{
2n/a0 "additionalProperties": false,
34211180 "properties": {
4437910 "name": {
5437910 "type": "string"
6437910 },
7419754 "overrides": {
8419744 "items": {
10419744 },
11424110 "type": "array"
12419754 },
1324280 "payload": {
14n/a0 "additionalProperties": false,
1524666 "properties": {
1629812 "type": {
1729812 "enum": [
18172n/a "json",
1971n/a "csv",
2039n/a "string",
2116n/a "number"
2229812 ],
2330010 "type": "string"
2429812 },
2525654 "value": {
2625654 "type": "string"
2725654 }
2824666 },
293084 "required": [
303102 "type",
313102 "value"
323084 ],
3331210 "type": "object"
3424280 },
35423954 "stickiness": {
36423954 "type": "string"
37423954 },
38437514 "weight": {
3943772 "maximum": 1000,
4043772 "minimum": 0,
41437910 "type": "number"
42437514 },
43423812 "weightType": {
44423812 "enum": [
454166n/a "variable",
4672n/a "fix"
47423812 ],
48424010 "type": "string"
49423812 }
504211180 },
5143874 "required": [
5243892 "name",
5343892 "weight"
5443874 ],
55439110 "type": "object"
564207194}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request39631ms
41531ms
Examples
Body: application/json
[ { "description": "Allows you to constrain on application name", "legalValues": [], "name": "appName", "sortOrder": 2, "stickiness": false } ]exportResultSchema.contextFields
"2023-06-29T10:19:00.000Z"contextFieldSchema.createdAt
"Used to uniquely identify users"contextFieldSchema.description
"Deep fuchsia"legalValueSchema.description
"#c154c1"legalValueSchema.value
"userId"contextFieldSchema.name
"my-project"contextFieldSchema.project
900contextFieldSchema.sortOrder
truecontextFieldSchema.stickiness
3contextFieldSchema.usedInFeatures
2contextFieldSchema.usedInProjects
falsedependentFeatureSchema.enabled
"parent_feature"dependentFeatureSchema.feature
[ "variantA", "variantB" ]dependentFeatureSchema.variants
"child_feature"featureDependenciesSchema.feature
[ { "enabled": true, "environment": "development", "featureName": "my-feature", "name": "variant-testing", "variants": [ { "name": "a", "overrides": [], "stickiness": "random", "weight": 500, "weightType": "variable" }, { "name": "b", "overrides": [], "stickiness": "random", "weight": 500, "weightType": "variable" } ] } ]exportResultSchema.featureEnvironments
truefeatureEnvironmentSchema.enabled
"development"featureEnvironmentSchema.environment
"disable-comments"featureEnvironmentSchema.featureName
"2023-01-28T16:21:39.975Z"featureEnvironmentSchema.lastSeenAt
"Phase One"featureEnvironmentSchema.milestoneName
0featureEnvironmentSchema.milestoneOrder
"my-dev-env"featureEnvironmentSchema.name
50featureEnvironmentSchema.no
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanSchema.activeMilestoneId
"2022-01-01T00:00:00Z"releasePlanSchema.createdAt
53releasePlanSchema.createdByUserId
"This is my release plan"releasePlanSchema.description
"plan"releasePlanSchema.discriminator
"production"releasePlanSchema.environment
"my-feature"releasePlanSchema.featureName
"01JB9GGTGQYEQ9D40R17T3YVW2"releasePlanSchema.id
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanMilestoneSchema.id
"My milestone"releasePlanMilestoneSchema.name
"2024-01-01T00:00:00.000Z"releasePlanMilestoneSchema.pausedAt
"2024-01-01T00:00:00.000Z"releasePlanMilestoneSchema.progressionExecutedAt
"01JB9GGTGQYEQ9D40R17T3YVW2"releasePlanMilestoneSchema.releasePlanDefinitionId
1releasePlanMilestoneSchema.sortOrder
"2024-01-01T00:00:00.000Z"releasePlanMilestoneSchema.startedAt
[ { "caseInsensitive": false, "contextName": "appName", "inverted": false, "operator": "IN", "values": [ "1", "2" ] } ]releasePlanMilestoneStrategySchema.constraints
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
falsereleasePlanMilestoneStrategySchema.disabled
"01JB9GGTGQYEQ9D40R17T3YVW3"releasePlanMilestoneStrategySchema.id
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanMilestoneStrategySchema.milestoneId
"flexibleRollout"releasePlanMilestoneStrategySchema.name
[ 1, 2 ]releasePlanMilestoneStrategySchema.segments
9999releasePlanMilestoneStrategySchema.sortOrder
"flexibleRollout"releasePlanMilestoneStrategySchema.strategyName
"Gradual Rollout 25-Prod"releasePlanMilestoneStrategySchema.title
"blue_group"createStrategyVariantSchema.name
{ "type": "json", "value": "{\"color\": \"red\"}" }createStrategyVariantSchema.payload
"custom.context.field"createStrategyVariantSchema.stickiness
"fix"createStrategyVariantSchema.weightType
"My release plan"releasePlanSchema.name
"01JB9GGTGQYEQ9D40R17T3YVW2"releasePlanSchema.releasePlanTemplateId
"01JB9GGTGQYEQ9D40R17T3YVW2"releasePlanSafeguardSchema.action.id
"pauseReleasePlanProgressions"releasePlanSafeguardSchema.action.type
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanSafeguardSchema.id
"rps"releasePlanSafeguardSchema.impactMetric.aggregationMode
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanSafeguardSchema.impactMetric.id
{ "environment": [ "development" ], "project": [ "default" ] }releasePlanSafeguardSchema.impactMetric.labelSelectors
"unleash_counter_feature_toggle_usage_total"releasePlanSafeguardSchema.impactMetric.metricName
"internal"releasePlanSafeguardSchema.impactMetric.source
"day"releasePlanSafeguardSchema.impactMetric.timeRange
">"safeguardTriggerConditionSchema.operator
100safeguardTriggerConditionSchema.threshold
"disableFeatureEnvironment"featureEnvironmentSafeguardSchema.action.type
"01JB9GGTGQYEQ9D40R17T3YVW1"featureEnvironmentSafeguardSchema.id
"rps"featureEnvironmentSafeguardSchema.impactMetric.aggregationMode
"01JB9GGTGQYEQ9D40R17T3YVW1"featureEnvironmentSafeguardSchema.impactMetric.id
{ "environment": [ "development" ], "project": [ "default" ] }featureEnvironmentSafeguardSchema.impactMetric.labelSelectors
"unleash_counter_feature_toggle_usage_total"featureEnvironmentSafeguardSchema.impactMetric.metricName
"internal"featureEnvironmentSafeguardSchema.impactMetric.source
"day"featureEnvironmentSafeguardSchema.impactMetric.timeRange
3featureEnvironmentSchema.sortOrder
falsefeatureStrategySchema.disabled
"myAwesomeFeature"featureStrategySchema.featureName
"6b5157cb-343a-41e7-bfa3-7b4ec3044840"featureStrategySchema.id
"flexibleRollout"featureStrategySchema.name
[ 1, 2 ]featureStrategySchema.segments
9999featureStrategySchema.sortOrder
"Gradual Rollout 25-Prod"featureStrategySchema.title
"blue_group"strategyVariantSchema.name
{ "type": "json", "value": "{\"color\": \"red\"}" }strategyVariantSchema.payload
"custom.context.field"strategyVariantSchema.stickiness
"fix"strategyVariantSchema.weightType
0featureEnvironmentSchema.totalMilestones
"development"featureEnvironmentSchema.type
"blue_group"variantSchema.name
"userId"overrideSchema.contextName
[ "red", "blue" ]overrideSchema.values
{ "type": "json", "value": "{\"color\": \"red\"}" }variantSchema.payload
"custom.context.field"variantSchema.stickiness
"variable"variantSchema.weightType
974featureEnvironmentSchema.yes
[ { "constraints": [], "disabled": false, "featureName": "my-feature", "id": "924974d7-8003-43ee-87eb-c5f887c06fd1", "name": "flexibleRollout", "parameters": { "groupId": "default", "rollout": "50", "stickiness": "random" }, "segments": [ 1 ], "title": "Rollout 50%" } ]exportResultSchema.featureStrategies
[ { "featureName": "my-feature", "tagType": "simple", "tagValue": "user-facing" } ]exportResultSchema.featureTags
1featureTagSchema.createdByUserId
"my-feature"featureTagSchema.featureName
"simple"featureTagSchema.tagType
"my-tag"featureTagSchema.tagValue
[ { "archived": false, "description": "best feature ever", "impressionData": false, "name": "my-feature", "project": "default", "stale": false, "type": "release" } ]exportResultSchema.features
truefeatureSchema.archived
"2023-01-29T15:21:39.975Z"featureSchema.archivedAt
"some-feature"featureSchema.children
123featureSchema.collaborators.users.id
"https://example.com/242x200.png"featureSchema.collaborators.users.imageUrl
"User"featureSchema.collaborators.users.name
"2023-01-28T15:21:39.975Z"featureSchema.createdAt
123featureSchema.createdBy.id
"https://example.com/242x200.png"featureSchema.createdBy.imageUrl
"User"featureSchema.createdBy.name
truefeatureSchema.dependencies.enabled
"some-feature"featureSchema.dependencies.feature
"some-feature-blue-variant"featureSchema.dependencies.variants
"Controls disabling of the comments section in case of an incident"featureSchema.description
truefeatureSchema.enabled
truefeatureSchema.favorite
falsefeatureSchema.impressionData
"2023-01-28T15:21:39.975Z"featureSchema.lifecycle.enteredStageAt
"initial"featureSchema.lifecycle.stage
"kept"featureSchema.lifecycle.status
"disable-comments"featureSchema.links.feature
"01JTJNCJ5XVP2KPJFA03YRBZCA"featureSchema.links.id
"Github cleanup"featureSchema.links.title
"https://github.com/search?q=cleanupReminder&type=code"featureSchema.links.url
"disable-comments"featureSchema.name
"dx-squad"featureSchema.project
falsefeatureSchema.stale
"#FFFFFF"tagSchema.color
"simple"tagSchema.type
"a-tag-value"tagSchema.value
"kill-switch"featureSchema.type
"child_feature"featureLinksSchema.feature
"Github cleanup"linkSchema.title
"https://github.com/search?q=cleanupReminder&type=code"linkSchema.url
[ { "id": 1, "name": "new-segment-name" } ]exportResultSchema.segments
[ { "description": "Used to simplify filtering of features", "icon": "#", "name": "simple" } ]exportResultSchema.tagTypes
"#FFFFFF"tagTypeSchema.color
"A tag type for describing the color of a tag."tagTypeSchema.description
"not-really-used"tagTypeSchema.icon
"color"tagTypeSchema.name
"development"importTogglesSchema.environment
"My awesome project"importTogglesSchema.project
Body
application/json399 / 422
importTogglesSchema
#validinvalidschema
16882360{
2n/a0 "additionalProperties": false,
36882360 "properties": {
46882360 "data": {
66882360 },
730480 "environment": {
830480 "type": "string"
930480 },
1030453 "project": {
1130453 "type": "string"
1230453 }
136882360 },
1430480 "required": [
1530480 "project",
1630480 "environment",
1730480 "data"
1830480 ],
1930480 "type": "object"
206882360}
Referenced Components (25)486 of 508 keywords
constraintSchema15 of 15 keywords
14076295{
2n/a0 "additionalProperties": false,
34092254 "properties": {
4217625 "caseInsensitive": {
5217625 "type": "boolean"
6217625 },
7431025 "contextName": {
8431025 "type": "string"
9431025 },
10230825 "inverted": {
11230825 "type": "boolean"
12230825 },
13424992 "operator": {
14424992 "enum": [
15227n/a "NOT_IN",
16609n/a "IN",
17186n/a "STR_ENDS_WITH",
18223n/a "STR_STARTS_WITH",
19195n/a "STR_CONTAINS",
20228n/a "NUM_EQ",
21163n/a "NUM_GT",
22222n/a "NUM_GTE",
23218n/a "NUM_LT",
24227n/a "NUM_LTE",
25232n/a "DATE_AFTER",
26261n/a "DATE_BEFORE",
27213n/a "SEMVER_EQ",
28132n/a "SEMVER_GT",
29257n/a "SEMVER_LT",
30225n/a "SEMVER_GTE",
31188n/a "SEMVER_LTE",
32243n/a "REGEX"
33424992 ],
34431625 "type": "string"
35424992 },
36207431 "value": {
3720746 "minLength": 1,
38208025 "type": "string"
39207431 },
40222256 "values": {
41222231 "items": {
42937043 "type": "string"
43222231 },
44225325 "type": "array"
45222256 }
464092254 },
47433016 "required": [
48433511 "contextName",
4943415 "operator"
50433016 ],
51434625 "type": "object"
524076295}
contextFieldSchema22 of 22 keywords
1249092{
2n/a0 "additionalProperties": false,
3249285 "properties": {
41916 "createdAt": {
51242 "format": "date-time",
6197n/a "nullable": true,
71934 "type": "string"
81916 },
923734 "description": {
102377n/a "nullable": true,
1123734 "type": "string"
1223734 },
13235242 "legalValues": {
14235219 "items": {
16235219 },
17237123 "type": "array"
18235242 },
1925705 "name": {
2025705 "type": "string"
2125705 },
221705 "project": {
231705 "type": "string"
241705 },
2523696 "sortOrder": {
2623696 "type": "integer"
2723696 },
2823685 "stickiness": {
2923685 "type": "boolean"
3023685 },
311726 "usedInFeatures": {
321341 "minimum": 0,
33178n/a "nullable": true,
341735 "type": "integer"
351726 },
361556 "usedInProjects": {
371121 "minimum": 0,
38161n/a "nullable": true,
391565 "type": "integer"
401556 }
41249285 },
4225752 "required": [
4325752 "name"
4425752 ],
4525775 "type": "object"
46249092}
createStrategyVariantSchema22 of 22 keywords
162118{
270100 "properties": {
314226 "name": {
414226 "type": "string"
514226 },
69336 "payload": {
79722 "properties": {
810512 "type": {
910512 "enum": [
1086n/a "json",
113n/a "csv",
1211n/a "string",
135n/a "number"
1410512 ],
1510710 "type": "string"
1610512 },
1710710 "value": {
1810710 "type": "string"
1910710 }
209722 },
211154 "required": [
221172 "type",
231172 "value"
241154 ],
2511910 "type": "object"
269336 },
2715810 "stickiness": {
2815810 "type": "string"
2915810 },
3015216 "weight": {
311562 "maximum": 1000,
321562 "minimum": 0,
3315612 "type": "integer"
3415216 },
3515612 "weightType": {
3615612 "enum": [
3739n/a "variable",
38117n/a "fix"
3915612 ],
4015810 "type": "string"
4115612 }
4270100 },
431628 "required": [
441682 "name",
451682 "weight",
461682 "weightType",
471682 "stickiness"
481628 ],
4917010 "type": "object"
5062118}
dependentFeatureSchema9 of 9 keywords
178327{
2n/a0 "additionalProperties": false,
378420 "properties": {
44055 "enabled": {
54055 "type": "boolean"
64055 },
77985 "feature": {
87985 "type": "string"
97985 },
1040210 "variants": {
114025 "items": {
1221295 "type": "string"
134025 },
144075 "type": "array"
1540210 }
1678420 },
178032 "required": [
188032 "feature"
198032 ],
208055 "type": "object"
2178327}
exportResultSchema27 of 29 keywords
16882360{
2n/a0 "additionalProperties": false,
36892359 "properties": {
4242081 "contextFields": {
5242076 "items": {
7242076 },
824965 "type": "array"
9242081 },
10238649 "dependencies": {
11238644 "items": {
13238644 },
1424305 "type": "array"
15238649 },
161532897 "featureEnvironments": {
171532892 "items": {
191532892 },
2024245 "type": "array"
211532897 },
222858190 "featureStrategies": {
232858185 "items": {
252858185 },
2630435 "type": "array"
272858190 },
28239731 "featureTags": {
29239726 "items": {
31239726 },
3224235 "type": "array"
33239731 },
3420171030 "features": {
3520171030 "items": {
3720171030 },
3830470 "type": "array"
3920171030 },
40236137 "links": {
41236132 "items": {
43236132 },
4423935 "type": "array"
45236137 },
46238622 "segments": {
47238617 "items": {
48n/a0 "additionalProperties": false,
49240210 "properties": {
5024065 "id": {
5124065 "type": "number"
5224065 },
5324065 "name": {
5424065 "type": "string"
5524065 }
56240210 },
5724102 "required": [
5824111 "id",
5924111 "name"
6024102 ],
6124125 "type": "object"
62238617 },
6324035 "type": "array"
64238622 },
65301731 "tagTypes": {
66301726 "items": {
68301726 },
6930435 "type": "array"
70301731 }
716892359 },
7230471 "required": [
7330471 "features",
7430480 "featureStrategies",
7530480 "tagTypes"
7630471 ],
7730480 "type": "object"
786882360}
featureDependenciesSchema8 of 8 keywords
125344{
2n/a0 "additionalProperties": false,
325537 "properties": {
425932 "dependencies": {
525927 "items": {
725927 },
82865 "type": "array"
925932 },
102865 "feature": {
112865 "type": "string"
122865 }
1325537 },
142902 "required": [
152911 "feature",
162911 "dependencies"
172902 ],
182925 "type": "object"
1925344}
featureEnvironmentSafeguardSchema35 of 35 keywords
1370231{
2n/a0 "additionalProperties": false,
3381210 "properties": {
453158 "action": {
5n/a0 "additionalProperties": false,
653940 "properties": {
756710 "environment": {
856710 "type": "string"
956710 },
1056710 "featureName": {
1156710 "type": "string"
1256710 },
1356710 "project": {
1456710 "type": "string"
1556710 },
1656710 "type": {
1756710 "type": "string"
1856710 }
1953940 },
205718 "required": [
215772 "type",
225772 "featureName",
235772 "environment",
245772 "project"
255718 ],
2657910 "type": "object"
2753158 },
2857610 "id": {
2957610 "type": "string"
3057610 },
31483106 "impactMetric": {
32n/a0 "additionalProperties": false,
3349386 "properties": {
3456512 "aggregationMode": {
3556512 "enum": [
36251n/a "rps",
3736n/a "count",
3865n/a "avg",
3918n/a "sum",
4066n/a "p95",
4172n/a "p99",
4257n/a "p50"
4356512 ],
4456710 "type": "string"
4556512 },
4656710 "id": {
4756710 "type": "string"
4856710 },
4954730 "labelSelectors": {
5046420 "additionalProperties": {
51122010 "items": {
52479610 "type": "string"
53122010 },
54123010 "type": "array"
5546420 },
5656710 "type": "object"
5754730 },
5856710 "metricName": {
5956710 "type": "string"
6056710 },
6136212 "source": {
6236212 "enum": [
63302n/a "internal",
6460n/a "external"
6536212 ],
6636410 "type": "string"
6736212 },
6856512 "timeRange": {
6956512 "enum": [
70121n/a "hour",
71287n/a "day",
72100n/a "week",
7357n/a "month"
7456512 ],
7556710 "type": "string"
7656512 }
7749386 },
7856910 "required": [
795772 "id",
805772 "metricName",
815772 "timeRange",
825772 "aggregationMode",
835772 "labelSelectors"
8456910 ],
8557910 "type": "object"
86483106 },
8755336 "triggerCondition": {
8955336 }
90381210 },
9158011 "required": [
925865 "id",
935892 "action",
945892 "triggerCondition",
955892 "impactMetric"
9658011 ],
9759110 "type": "object"
98370231}
featureEnvironmentSchema34 of 34 keywords
117601764{
2n/a0 "additionalProperties": false,
317641755 "properties": {
4175520 "changeRequestIds": {
5175510 "items": {
629010 "type": "number"
7175510 },
8176510 "type": "array"
9175520 },
1035135 "enabled": {
1135135 "type": "boolean"
1235135 },
13316424 "environment": {
14316424 "type": "string"
15316424 },
1631835 "featureName": {
1731835 "type": "string"
1831835 },
19178010 "hasEnabledStrategies": {
20178010 "type": "boolean"
21178010 },
22173410 "hasStrategies": {
23173410 "type": "boolean"
24173410 },
25173916 "lastSeenAt": {
2617134 "format": "date-time",
271755n/a "nullable": true,
28174312 "type": "string"
29173916 },
30174010 "milestoneName": {
31174010 "type": "string"
32174010 },
33176012 "milestoneOrder": {
34176012 "type": "number"
35176012 },
3635115 "name": {
3735115 "type": "string"
3835115 },
39177014 "no": {
4017722 "minimum": 0,
41177212 "type": "integer"
42177014 },
43928822 "releasePlans": {
44928812 "items": {
46928812 },
47174010 "type": "array"
48928822 },
491530241 "safeguards": {
501530231 "items": {
521530231 },
53176110 "type": "array"
541530241 },
5517845 "sortOrder": {
5617845 "type": "number"
5717845 },
581470338 "strategies": {
591470333 "items": {
611470333 },
6218035 "type": "array"
631470338 },
64177610 "totalMilestones": {
65177610 "type": "number"
66177610 },
6717585 "type": {
6817585 "type": "string"
6917585 },
7017775 "variantCount": {
7117775 "type": "number"
7217775 },
733004195 "variants": {
743004176 "items": {
763004176 },
77318019 "type": "array"
783004195 },
79172914 "yes": {
8017312 "minimum": 0,
81173112 "type": "integer"
82172914 }
8317641755 },
8435154 "required": [
8535163 "name",
8635181 "enabled"
8735154 ],
8835195 "type": "object"
8917601764}
featureLinksSchema8 of 8 keywords
112032{
2n/a0 "additionalProperties": false,
312225 "properties": {
41415 "feature": {
51415 "type": "string"
61415 },
712620 "links": {
812615 "items": {
1012615 },
111415 "type": "array"
1212620 }
1312225 },
141452 "required": [
151461 "feature",
161461 "links"
171452 ],
181475 "type": "object"
1912032}
featureSchema63 of 83 keywords
118601039{
2n/a0 "additionalProperties": false,
318601032 "properties": {
423674 "archived": {
523674 "type": "boolean"
623674 },
710834 "archivedAt": {
810264 "format": "date-time",
91087n/a "nullable": true,
1010870 "type": "string"
1110834 },
12105710 "children": {
1310575 "items": {
143145 "type": "string"
1510575 },
1610625 "type": "array"
17105710 },
18104044 "collaborators": {
19104038 "properties": {
20104038 "users": {
21104033 "items": {
2230118 "properties": {
233056 "id": {
243056 "type": "integer"
253056 },
263135 "imageUrl": {
273135 "type": "string"
283135 },
293117 "name": {
303117 "type": "string"
313117 }
3230118 },
3330910 "required": [
343118 "id",
353181 "name",
363181 "imageUrl"
3730910 ],
383195 "type": "object"
39104033 },
4010735 "type": "array"
41104038 }
42104038 },
4310781 "required": [
4410781 "users"
4510781 ],
4610795 "type": "object"
47104044 },
4811030 "createdAt": {
4910360 "format": "date-time",
501103n/a "nullable": true,
5111030 "type": "string"
5211030 },
5311080 "createdBy": {
54n/a0 "additionalProperties": false,
5511080 "properties": {
5611080 "id": {
5711080 "type": "integer"
5811080 },
5911080 "imageUrl": {
6011080 "type": "string"
6111080 },
6211080 "name": {
6311080 "type": "string"
6411080 }
6511080 },
6611080 "required": [
6711080 "id",
6811080 "name",
6911080 "imageUrl"
7011080 ],
7111080 "type": "object"
7211080 },
73105132 "dependencies": {
74105127 "items": {
75n/a0 "additionalProperties": false,
7657920 "properties": {
772905 "enabled": {
782905 "type": "boolean"
792905 },
805925 "feature": {
815925 "type": "string"
825925 },
8327810 "variants": {
842785 "items": {
8515765 "type": "string"
862785 },
872835 "type": "array"
8827810 }
8957920 },
905972 "required": [
915972 "feature"
925972 ],
935995 "type": "object"
94105127 },
9510785 "type": "array"
96105132 },
9723710 "description": {
982371n/a "nullable": true,
9923710 "type": "string"
10023710 },
10110790 "enabled": {
10210790 "type": "boolean"
10310790 },
104251853 "environments": {
105251853 "items": {
107251853 },
10811040 "type": "array"
109251853 },
11010970 "favorite": {
11110970 "type": "boolean"
11210970 },
11323973 "impressionData": {
11423973 "type": "boolean"
11523973 },
116104725 "lifecycle": {
117n/a0 "additionalProperties": false,
118104918 "properties": {
11910606 "enteredStageAt": {
12010601 "format": "date-time",
12110615 "type": "string"
12210606 },
12310606 "stage": {
12410606 "enum": [
125996n/a "initial",
1269n/a "pre-live",
12728n/a "live",
12812n/a "completed",
12915n/a "archived"
13010606 ],
13110615 "type": "string"
13210606 },
13310086 "status": {
1341014n/a "nullable": true,
13510086 "type": "string"
13610086 }
137104918 },
13810652 "required": [
13910661 "stage",
14010661 "enteredStageAt"
14110652 ],
14210675 "type": "object"
143104725 },
144106631 "links": {
145106626 "items": {
146n/a0 "additionalProperties": false,
14748419 "properties": {
1482455 "feature": {
1492455 "type": "string"
1502455 },
1514975 "id": {
1524975 "type": "string"
1534975 },
1542354 "title": {
155239n/a "nullable": true,
1562354 "type": "string"
1572354 },
1584975 "url": {
1594975 "type": "string"
1604975 }
16148419 },
1625012 "required": [
1635021 "id",
1645021 "url"
1655012 ],
1665035 "type": "object"
167106626 },
16810925 "type": "array"
169106631 },
17028920 "name": {
17128920 "type": "string"
17228920 },
17323470 "project": {
17423470 "type": "string"
17523470 },
17624070 "stale": {
17724070 "type": "boolean"
17824070 },
179103332 "tags": {
180100928 "items": {
182100928 },
1831065n/a "nullable": true,
18410614 "type": "array"
185103332 },
18623480 "type": {
18723480 "type": "string"
18823480 }
18918601032 },
19028927 "required": [
19128927 "name"
19228927 ],
19328990 "type": "object"
19418601039}
featureStrategySchema20 of 20 keywords
13625528{
2n/a0 "additionalProperties": false,
33635501 "properties": {
43202174 "constraints": {
53202159 "items": {
73202159 },
8336115 "type": "array"
93202174 },
10331512 "disabled": {
113327n/a "nullable": true,
12331512 "type": "boolean"
13331512 },
14341615 "featureName": {
15341615 "type": "string"
16341615 },
17327515 "id": {
18327515 "type": "string"
19327515 },
20411115 "name": {
21411115 "type": "string"
22411115 },
23331630 "parameters": {
25331630 },
26333930 "segments": {
27333915 "items": {
28765415 "type": "number"
29333915 },
30335415 "type": "array"
31333930 },
32125415 "sortOrder": {
33125415 "type": "number"
34125415 },
35332912 "title": {
363341n/a "nullable": true,
37332912 "type": "string"
38332912 },
391077183 "variants": {
401077162 "items": {
421077162 },
43123921 "type": "array"
441077183 }
453635501 },
46412613 "required": [
47412613 "name"
48412613 ],
49413914 "type": "object"
503625528}
featureTagSchema10 of 10 keywords
1244026{
2n/a0 "additionalProperties": false,
3244219 "properties": {
41214 "createdByUserId": {
5125n/a "nullable": true,
61214 "type": "number"
71214 },
824555 "featureName": {
924555 "type": "string"
1024555 },
1123365 "tagType": {
1223365 "type": "string"
1323365 },
1424555 "tagValue": {
1524555 "type": "string"
1624555 }
17244219 },
1824592 "required": [
1924601 "featureName",
2024601 "tagValue"
2124592 ],
2224615 "type": "object"
23244026}
legalValueSchema7 of 7 keywords
142519{
2n/a0 "additionalProperties": false,
342610 "properties": {
42305 "description": {
52305 "type": "string"
62305 },
74305 "value": {
84305 "type": "string"
94305 }
1042610 },
114354 "required": [
124354 "value"
134354 ],
144395 "type": "object"
1542519}
linkSchema8 of 8 keywords
144315{
24449 "properties": {
32274 "title": {
4231n/a "nullable": true,
52274 "type": "string"
62274 },
74475 "url": {
84475 "type": "string"
94475 }
104449 },
114521 "required": [
124521 "url"
134521 ],
144535 "type": "object"
1544315}
overrideSchema8 of 8 keywords
196280{
2n/a0 "additionalProperties": false,
396666 "properties": {
498446 "contextName": {
598446 "type": "string"
698446 },
7101020 "values": {
8101010 "items": {
9508810 "type": "string"
10101010 },
11102010 "type": "array"
12101020 }
1396666 },
1410284 "required": [
1510302 "contextName",
1610302 "values"
1710284 ],
18103210 "type": "object"
1996280}
parametersSchema2 of 2 keywords
1366550{
2272025 "additionalProperties": {
3832725 "type": "string"
4272025 },
5369025 "type": "object"
6366550}
releasePlanMilestoneSchema23 of 23 keywords
1143465{
2n/a0 "additionalProperties": false,
3151447 "properties": {
458610 "id": {
55942 "nullable": false,
658610 "type": "string"
758610 },
858610 "name": {
958610 "type": "string"
1058610 },
1149012 "pausedAt": {
124674 "format": "date-time",
13502n/a "nullable": true,
144948 "type": "string"
1549012 },
1647912 "progressionExecutedAt": {
174664 "format": "date-time",
18491n/a "nullable": true,
194838 "type": "string"
2047912 },
2158610 "releasePlanDefinitionId": {
2258610 "type": "string"
2358610 },
2458412 "sortOrder": {
2558412 "type": "integer"
2658412 },
2750512 "startedAt": {
284664 "format": "date-time",
29517n/a "nullable": true,
305098 "type": "string"
3150512 },
32147361 "strategies": {
33147351 "items": {
35147351 },
3649810 "type": "array"
37147361 },
385048 "transitionCondition": {
39512n/a "nullable": true,
405048 "type": "object"
415048 }
42151447 },
435908 "required": [
445962 "id",
455962 "name",
465962 "sortOrder",
475962 "releasePlanDefinitionId"
485908 ],
4959810 "type": "object"
50143465}
releasePlanMilestoneStrategySchema22 of 22 keywords
177351{
2n/a0 "additionalProperties": false,
387331 "properties": {
4259101 "constraints": {
525991 "items": {
725991 },
835010 "type": "array"
9259101 },
103568 "disabled": {
11364n/a "nullable": true,
123568 "type": "boolean"
133568 },
1440610 "id": {
154142 "nullable": false,
1640610 "type": "string"
1740610 },
1840610 "milestoneId": {
1940610 "type": "string"
2040610 },
2140610 "name": {
2240610 "type": "string"
2340610 },
2434920 "parameters": {
26 "example": {
27 "groupId": "some_new",
28 "rollout": "25",
29 "stickiness": "sessionId"
30 }
3134920 },
3234420 "segments": {
3334410 "items": {
3474910 "type": "number"
3534410 },
3635410 "type": "array"
3734420 },
3840610 "sortOrder": {
3940610 "type": "number"
4040610 },
4140610 "strategyName": {
4240610 "type": "string"
4340610 },
443568 "title": {
45364n/a "nullable": true,
463568 "type": "string"
473568 },
48251124 "variants": {
49251114 "items": {
51251114 },
5236510 "type": "array"
53251124 }
5487331 },
5540810 "required": [
564162 "id",
574162 "milestoneId",
584162 "sortOrder",
594162 "name",
604162 "strategyName"
6140810 ],
6241810 "type": "object"
6377351}
releasePlanSafeguardSchema33 of 33 keywords
160212{
2n/a0 "additionalProperties": false,
368194 "properties": {
422634 "action": {
5n/a0 "additionalProperties": false,
623020 "properties": {
723810 "id": {
823810 "type": "string"
923810 },
1023810 "type": {
1123810 "type": "string"
1223810 }
1323020 },
142464 "required": [
152482 "type",
162482 "id"
172464 ],
1825010 "type": "object"
1922634 },
2024218 "id": {
2124218 "type": "string"
2224218 },
23154106 "impactMetric": {
24n/a0 "additionalProperties": false,
2516486 "properties": {
2623612 "aggregationMode": {
2723612 "enum": [
28190n/a "rps",
294n/a "count",
3017n/a "avg",
310n/a "sum",
328n/a "p95",
335n/a "p99",
3412n/a "p50"
3523612 ],
3623810 "type": "string"
3723612 },
3823810 "id": {
3923810 "type": "string"
4023810 },
4121830 "labelSelectors": {
4220220 "additionalProperties": {
4347710 "items": {
4488510 "type": "string"
4547710 },
4648710 "type": "array"
4720220 },
4823810 "type": "object"
4921830 },
5023810 "metricName": {
5123810 "type": "string"
5223810 },
5320212 "source": {
5420212 "enum": [
55189n/a "internal",
5613n/a "external"
5720212 ],
5820410 "type": "string"
5920212 },
6023612 "timeRange": {
6123612 "enum": [
626n/a "hour",
63199n/a "day",
641n/a "week",
6530n/a "month"
6623612 ],
6723810 "type": "string"
6823612 }
6916486 },
7024010 "required": [
712482 "id",
722482 "metricName",
732482 "timeRange",
742482 "aggregationMode",
752482 "labelSelectors"
7624010 ],
7725010 "type": "object"
78154106 },
7922436 "triggerCondition": {
8122436 }
8268194 },
832548 "required": [
842602 "id",
852602 "action",
862602 "triggerCondition",
872602 "impactMetric"
882548 ],
8926210 "type": "object"
9060212}
releasePlanSchema29 of 29 keywords
168814{
2n/a0 "additionalProperties": false,
386786 "properties": {
48128 "activeMilestoneId": {
5820n/a "nullable": true,
68128 "type": "string"
78128 },
885812 "createdAt": {
98582 "format": "date-time",
108682 "nullable": false,
1186010 "type": "string"
1285812 },
1386010 "createdByUserId": {
148682 "nullable": false,
1586010 "type": "number"
1686010 },
178158 "description": {
18823n/a "nullable": true,
198158 "type": "string"
208158 },
2185812 "discriminator": {
2285812 "enum": [
23858n/a "plan"
2485812 ],
258682 "nullable": false,
2686010 "type": "string"
2785812 },
2886010 "environment": {
2986010 "type": "string"
3086010 },
3186010 "featureName": {
3286010 "type": "string"
3386010 },
3486010 "id": {
358682 "nullable": false,
3686010 "type": "string"
3786010 },
38404466 "milestones": {
39404456 "items": {
41404456 },
4286010 "type": "array"
43404466 },
4486010 "name": {
4586010 "type": "string"
4686010 },
4786010 "releasePlanTemplateId": {
488682 "nullable": false,
4986010 "type": "string"
5086010 },
51605220 "safeguards": {
52605210 "items": {
54605210 },
5581510 "type": "array"
56605220 }
5786786 },
5885418 "required": [
598702 "id",
608702 "discriminator",
618702 "name",
628702 "featureName",
638702 "environment",
648702 "createdByUserId",
658702 "createdAt",
668702 "milestones",
678702 "releasePlanTemplateId"
6885418 ],
6987210 "type": "object"
7068814}
safeguardTriggerConditionSchema9 of 9 keywords
177772{
2n/a0 "additionalProperties": false,
378544 "properties": {
480124 "operator": {
580124 "enum": [
6568n/a ">",
7233n/a "<"
880124 ],
980520 "type": "string"
1080124 },
1180520 "threshold": {
1280520 "type": "number"
1380520 }
1478544 },
158218 "required": [
168254 "operator",
178254 "threshold"
188218 ],
1982920 "type": "object"
2077772}
strategyVariantSchema22 of 22 keywords
13022162{
2n/a0 "additionalProperties": false,
33035134 "properties": {
4315015 "name": {
5315015 "type": "string"
6315015 },
7148659 "payload": {
8149634 "properties": {
9150419 "type": {
10150419 "enum": [
11410n/a "json",
12358n/a "csv",
13433n/a "string",
14303n/a "number"
15150419 ],
16150815 "type": "string"
17150419 },
18151215 "value": {
19151215 "type": "string"
20151215 }
21149634 },
22152010 "required": [
2315237 "type",
2415273 "value"
25152010 ],
26153015 "type": "object"
27148659 },
28315115 "stickiness": {
29315115 "type": "string"
30315115 },
31314125 "weight": {
3231483 "maximum": 1000,
3331474 "minimum": 0,
34314818 "type": "integer"
35314125 },
36314620 "weightType": {
37314620 "enum": [
381521n/a "variable",
391625n/a "fix"
40314620 ],
41315115 "type": "string"
42314620 }
433035134 },
44315613 "required": [
4531654 "name",
4631663 "weight",
4731663 "weightType",
4831663 "stickiness"
49315613 ],
50316915 "type": "object"
513022162}
tagSchema14 of 14 keywords
112229{
2n/a0 "additionalProperties": false,
312420 "properties": {
4846 "color": {
590n/a "nullable": true,
6502 "pattern": "^#[0-9A-Fa-f]{6}$",
7864 "type": "string"
8846 },
91367 "type": {
101371 "maxLength": 50,
111371 "minLength": 2,
121385 "type": "string"
131367 },
141367 "value": {
151371 "maxLength": 50,
161371 "minLength": 2,
171385 "type": "string"
181367 }
1912420 },
201422 "required": [
211431 "value",
221431 "type"
231422 ],
241447 "type": "object"
2512229}
tagTypeSchema12 of 12 keywords
1299126{
2n/a0 "additionalProperties": false,
3299220 "properties": {
43436 "color": {
5349n/a "nullable": true,
61682 "pattern": "^#[0-9A-Fa-f]{6}$",
73454 "type": "string"
83436 },
925715 "description": {
1025715 "type": "string"
1125715 },
1225474 "icon": {
132551n/a "nullable": true,
1425474 "type": "string"
1525474 },
1630065 "name": {
1730065 "type": "string"
1830065 }
19299220 },
2030111 "required": [
2130111 "name"
2230111 ],
2330125 "type": "object"
24299126}
variantSchema24 of 24 keywords
13020290{
2n/a0 "additionalProperties": false,
33024276 "properties": {
4328810 "name": {
5328810 "type": "string"
6328810 },
7308472 "overrides": {
8308462 "items": {
10308462 },
11314610 "type": "array"
12308472 },
1331536 "payload": {
14n/a0 "additionalProperties": false,
1531922 "properties": {
1632712 "type": {
1732712 "enum": [
18179n/a "json",
1953n/a "csv",
2043n/a "string",
2152n/a "number"
2232712 ],
2332910 "type": "string"
2432712 },
2532910 "value": {
2632910 "type": "string"
2732910 }
2831922 },
293374 "required": [
303392 "type",
313392 "value"
323374 ],
3334110 "type": "object"
3431536 },
35311110 "stickiness": {
36311110 "type": "string"
37311110 },
38328414 "weight": {
3932862 "maximum": 1000,
4032862 "minimum": 0,
41328810 "type": "number"
42328414 },
433057134 "weightType": {
443057134 "enum": [
452997n/a "variable",
4660n/a "fix"
473057134 ],
48318110 "type": "string"
493057134 }
503024276 },
5132964 "required": [
5232982 "name",
5332982 "weight"
5432964 ],
55330010 "type": "object"
563020290}
Responses
codedescriptionhitsavg
200importTogglesValidateSchema12444ms
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
41511ms
400Bad Request18891ms
500Internal Server Error125ms
Examples
Body: application/json
[ { "description": "Allows you to constrain on application name", "legalValues": [], "name": "appName", "sortOrder": 2, "stickiness": false } ]exportResultSchema.contextFields
"2023-06-29T10:19:00.000Z"contextFieldSchema.createdAt
"Used to uniquely identify users"contextFieldSchema.description
"Deep fuchsia"legalValueSchema.description
"#c154c1"legalValueSchema.value
"userId"contextFieldSchema.name
"my-project"contextFieldSchema.project
900contextFieldSchema.sortOrder
truecontextFieldSchema.stickiness
3contextFieldSchema.usedInFeatures
2contextFieldSchema.usedInProjects
falsedependentFeatureSchema.enabled
"parent_feature"dependentFeatureSchema.feature
[ "variantA", "variantB" ]dependentFeatureSchema.variants
"child_feature"featureDependenciesSchema.feature
[ { "enabled": true, "environment": "development", "featureName": "my-feature", "name": "variant-testing", "variants": [ { "name": "a", "overrides": [], "stickiness": "random", "weight": 500, "weightType": "variable" }, { "name": "b", "overrides": [], "stickiness": "random", "weight": 500, "weightType": "variable" } ] } ]exportResultSchema.featureEnvironments
truefeatureEnvironmentSchema.enabled
"development"featureEnvironmentSchema.environment
"disable-comments"featureEnvironmentSchema.featureName
"2023-01-28T16:21:39.975Z"featureEnvironmentSchema.lastSeenAt
"Phase One"featureEnvironmentSchema.milestoneName
0featureEnvironmentSchema.milestoneOrder
"my-dev-env"featureEnvironmentSchema.name
50featureEnvironmentSchema.no
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanSchema.activeMilestoneId
"2022-01-01T00:00:00Z"releasePlanSchema.createdAt
53releasePlanSchema.createdByUserId
"This is my release plan"releasePlanSchema.description
"plan"releasePlanSchema.discriminator
"production"releasePlanSchema.environment
"my-feature"releasePlanSchema.featureName
"01JB9GGTGQYEQ9D40R17T3YVW2"releasePlanSchema.id
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanMilestoneSchema.id
"My milestone"releasePlanMilestoneSchema.name
"2024-01-01T00:00:00.000Z"releasePlanMilestoneSchema.pausedAt
"2024-01-01T00:00:00.000Z"releasePlanMilestoneSchema.progressionExecutedAt
"01JB9GGTGQYEQ9D40R17T3YVW2"releasePlanMilestoneSchema.releasePlanDefinitionId
1releasePlanMilestoneSchema.sortOrder
"2024-01-01T00:00:00.000Z"releasePlanMilestoneSchema.startedAt
[ { "caseInsensitive": false, "contextName": "appName", "inverted": false, "operator": "IN", "values": [ "1", "2" ] } ]releasePlanMilestoneStrategySchema.constraints
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
falsereleasePlanMilestoneStrategySchema.disabled
"01JB9GGTGQYEQ9D40R17T3YVW3"releasePlanMilestoneStrategySchema.id
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanMilestoneStrategySchema.milestoneId
"flexibleRollout"releasePlanMilestoneStrategySchema.name
[ 1, 2 ]releasePlanMilestoneStrategySchema.segments
9999releasePlanMilestoneStrategySchema.sortOrder
"flexibleRollout"releasePlanMilestoneStrategySchema.strategyName
"Gradual Rollout 25-Prod"releasePlanMilestoneStrategySchema.title
"blue_group"createStrategyVariantSchema.name
{ "type": "json", "value": "{\"color\": \"red\"}" }createStrategyVariantSchema.payload
"custom.context.field"createStrategyVariantSchema.stickiness
"fix"createStrategyVariantSchema.weightType
"My release plan"releasePlanSchema.name
"01JB9GGTGQYEQ9D40R17T3YVW2"releasePlanSchema.releasePlanTemplateId
"01JB9GGTGQYEQ9D40R17T3YVW2"releasePlanSafeguardSchema.action.id
"pauseReleasePlanProgressions"releasePlanSafeguardSchema.action.type
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanSafeguardSchema.id
"rps"releasePlanSafeguardSchema.impactMetric.aggregationMode
"01JB9GGTGQYEQ9D40R17T3YVW1"releasePlanSafeguardSchema.impactMetric.id
{ "environment": [ "development" ], "project": [ "default" ] }releasePlanSafeguardSchema.impactMetric.labelSelectors
"unleash_counter_feature_toggle_usage_total"releasePlanSafeguardSchema.impactMetric.metricName
"internal"releasePlanSafeguardSchema.impactMetric.source
"day"releasePlanSafeguardSchema.impactMetric.timeRange
">"safeguardTriggerConditionSchema.operator
100safeguardTriggerConditionSchema.threshold
"disableFeatureEnvironment"featureEnvironmentSafeguardSchema.action.type
"01JB9GGTGQYEQ9D40R17T3YVW1"featureEnvironmentSafeguardSchema.id
"rps"featureEnvironmentSafeguardSchema.impactMetric.aggregationMode
"01JB9GGTGQYEQ9D40R17T3YVW1"featureEnvironmentSafeguardSchema.impactMetric.id
{ "environment": [ "development" ], "project": [ "default" ] }featureEnvironmentSafeguardSchema.impactMetric.labelSelectors
"unleash_counter_feature_toggle_usage_total"featureEnvironmentSafeguardSchema.impactMetric.metricName
"internal"featureEnvironmentSafeguardSchema.impactMetric.source
"day"featureEnvironmentSafeguardSchema.impactMetric.timeRange
3featureEnvironmentSchema.sortOrder
falsefeatureStrategySchema.disabled
"myAwesomeFeature"featureStrategySchema.featureName
"6b5157cb-343a-41e7-bfa3-7b4ec3044840"featureStrategySchema.id
"flexibleRollout"featureStrategySchema.name
[ 1, 2 ]featureStrategySchema.segments
9999featureStrategySchema.sortOrder
"Gradual Rollout 25-Prod"featureStrategySchema.title
"blue_group"strategyVariantSchema.name
{ "type": "json", "value": "{\"color\": \"red\"}" }strategyVariantSchema.payload
"custom.context.field"strategyVariantSchema.stickiness
"fix"strategyVariantSchema.weightType
0featureEnvironmentSchema.totalMilestones
"development"featureEnvironmentSchema.type
"blue_group"variantSchema.name
"userId"overrideSchema.contextName
[ "red", "blue" ]overrideSchema.values
{ "type": "json", "value": "{\"color\": \"red\"}" }variantSchema.payload
"custom.context.field"variantSchema.stickiness
"variable"variantSchema.weightType
974featureEnvironmentSchema.yes
[ { "constraints": [], "disabled": false, "featureName": "my-feature", "id": "924974d7-8003-43ee-87eb-c5f887c06fd1", "name": "flexibleRollout", "parameters": { "groupId": "default", "rollout": "50", "stickiness": "random" }, "segments": [ 1 ], "title": "Rollout 50%" } ]exportResultSchema.featureStrategies
[ { "featureName": "my-feature", "tagType": "simple", "tagValue": "user-facing" } ]exportResultSchema.featureTags
1featureTagSchema.createdByUserId
"my-feature"featureTagSchema.featureName
"simple"featureTagSchema.tagType
"my-tag"featureTagSchema.tagValue
[ { "archived": false, "description": "best feature ever", "impressionData": false, "name": "my-feature", "project": "default", "stale": false, "type": "release" } ]exportResultSchema.features
truefeatureSchema.archived
"2023-01-29T15:21:39.975Z"featureSchema.archivedAt
"some-feature"featureSchema.children
123featureSchema.collaborators.users.id
"https://example.com/242x200.png"featureSchema.collaborators.users.imageUrl
"User"featureSchema.collaborators.users.name
"2023-01-28T15:21:39.975Z"featureSchema.createdAt
123featureSchema.createdBy.id
"https://example.com/242x200.png"featureSchema.createdBy.imageUrl
"User"featureSchema.createdBy.name
truefeatureSchema.dependencies.enabled
"some-feature"featureSchema.dependencies.feature
"some-feature-blue-variant"featureSchema.dependencies.variants
"Controls disabling of the comments section in case of an incident"featureSchema.description
truefeatureSchema.enabled
truefeatureSchema.favorite
falsefeatureSchema.impressionData
"2023-01-28T15:21:39.975Z"featureSchema.lifecycle.enteredStageAt
"initial"featureSchema.lifecycle.stage
"kept"featureSchema.lifecycle.status
"disable-comments"featureSchema.links.feature
"01JTJNCJ5XVP2KPJFA03YRBZCA"featureSchema.links.id
"Github cleanup"featureSchema.links.title
"https://github.com/search?q=cleanupReminder&type=code"featureSchema.links.url
"disable-comments"featureSchema.name
"dx-squad"featureSchema.project
falsefeatureSchema.stale
"#FFFFFF"tagSchema.color
"simple"tagSchema.type
"a-tag-value"tagSchema.value
"kill-switch"featureSchema.type
"child_feature"featureLinksSchema.feature
"Github cleanup"linkSchema.title
"https://github.com/search?q=cleanupReminder&type=code"linkSchema.url
[ { "id": 1, "name": "new-segment-name" } ]exportResultSchema.segments
[ { "description": "Used to simplify filtering of features", "icon": "#", "name": "simple" } ]exportResultSchema.tagTypes
"#FFFFFF"tagTypeSchema.color
"A tag type for describing the color of a tag."tagTypeSchema.description
"not-really-used"tagTypeSchema.icon
"color"tagTypeSchema.name
"development"importTogglesSchema.environment
"My awesome project"importTogglesSchema.project
Instance Admin 2 operations 2 covered 0 partial 0 uncovered 0 not measured — #
Responses
codedescriptionhitsavg
200instanceAdminStatsSchema8023ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Responses
codedescriptionhitsavg
200instanceAdminStatsSchemaCsv8023ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Maintenance 2 operations 1 covered 1 partial 0 uncovered 0 not measured 25% #
Responses
codedescriptionhitsavg
200maintenanceSchema8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Body
application/json1 / 4
toggleMaintenanceSchema
#validinvalidschema
175284{
27520 "properties": {
37520 "enabled": {
47520 "type": "boolean"
57520 }
67520 },
77520 "required": [
87520 "enabled"
97520 ],
1075284 "type": "object"
1175284}
Responses
codedescriptionhitsavg
204This response has no body.7494ms
400The request data does not match what we expect.1651ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
Examples
Body: application/json
truetoggleMaintenanceSchema.enabled
Metrics 9 operations 9 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
name1 / 1
#validinvalidschema
1976n/a{
2976n/a "type": "string"
3976n/a}
Responses
codedescriptionhitsavg
200featureUsageSchema9731ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Path Parameters
name1 / 1
#validinvalidschema
1880n/a{
2880n/a "type": "string"
3880n/a}
Responses
codedescriptionhitsavg
200featureMetricsSchema8771ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Query Parameters
query1 / 1
#validinvalidschema
1243n/a{
2243n/a "type": "string"
3243n/a}
offset1 / 1
1229n/a{
2229n/a "type": "string"
3229n/a}
limit1 / 1
1243n/a{
2243n/a "type": "string"
3243n/a}
sortBy1 / 1
1222n/a{
2222n/a "type": "string"
3222n/a}
sortOrder1 / 1
1198n/a{
2198n/a "type": "string"
3198n/a}
Responses
codedescriptionhitsavg
200applicationsSchema8112ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Examples
Query
"first_app"query
"50"offset
"50"limit
"type"sortBy
"desc"sortOrder
Path Parameters
appName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200This response has no body.8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Path Parameters
appName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200applicationSchema4811ms
404The requested resource was not found.3211ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Path Parameters
appName1 / 1
#validinvalidschema
1946n/a{
2946n/a "type": "string"
3946n/a}
Body
application/json7 / 7
createApplicationSchema
1654239{
2217184 "properties": {
325434 "color": {
425434 "type": "string"
525434 },
620184 "icon": {
720184 "type": "string"
820184 },
9169139 "strategies": {
1016966 "items": {
11684466 "type": "string"
1216966 },
1323573 "type": "array"
14169139 },
1519684 "url": {
1619684 "type": "string"
1719684 }
18217184 },
1983855 "type": "object"
20654239}
Responses
codedescriptionhitsavg
202This response has no body.6924ms
400The request data does not match what we expect.2421ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
500Internal Server Error61ms
Examples
Body: application/json
"red"createApplicationSchema.color
"https://github.com/favicon.ico"createApplicationSchema.icon
[ "standard", "gradualRollout", "mySpecialCustomStrategy" ]createApplicationSchema.strategies
"https://github.com/Unleash/unleash-proxy-client-js"createApplicationSchema.url
Path Parameters
appName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200applicationOverviewSchema8021ms
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Path Parameters
appName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
environment1 / 1
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200applicationEnvironmentInstancesSchema8021ms
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Responses
codedescriptionhitsavg
200outdatedSdksSchema8021ms
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Operational 2 operations 2 covered 0 partial 0 uncovered 0 not measured — #
Responses
codedescriptionhitsavg
200healthCheckSchema16030ms
500healthCheckSchema0never seen
Responses
codedescriptionhitsavg
200readyCheckSchema16030ms
503This response has no body.0never seen
Personal access tokens 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200#/components/schemas/patsSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation17681ms
404The requested resource was not found.0never seen
Body
application/json6 / 6
createPatSchema
#validinvalidschema
11120246{
21149186 "properties": {
3122682 "description": {
4122682 "type": "string"
5122682 },
61165168 "expiresAt": {
71165135 "format": "date-time",
8130033 "type": "string"
91165168 }
101149186 },
11130642 "required": [
12130840 "description",
13133315 "expiresAt"
14130642 ],
15134818 "type": "object"
161120246}
Responses
codedescriptionhitsavg
201The resource was successfully created.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation11351ms
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
400Bad Request7161ms
Examples
Body: application/json
"user:xyzrandomstring"createPatSchema.description
"2023-04-19T08:15:14.000Z"createPatSchema.expiresAt
Path Parameters
id1 / 1
#validinvalidschema
1577231{
2577231 "type": "integer"
3577231}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2291ms
500Internal Server Error5791ms
Playground 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json24 / 24
playgroundRequestSchema
#validinvalidschema
1658199{
2677170 "properties": {
3715129 "context": {
5715129 },
681219 "environment": {
781219 "type": "string"
881219 },
924148 "projects": {
1024148 "oneOf": [
11172117 {
1217227 "items": {
13271177 "type": "string"
1417227 },
1519990 "type": "array"
16172117 },
1769220 {
1869220 "enum": [
1969n/a "*"
2069220 ],
2177212 "type": "string"
2269220 }
2324148 ]
2424148 }
25677170 },
2682822 "required": [
2783119 "environment",
288446 "context"
2982822 ],
308507 "type": "object"
31658199}
Referenced Components (1)16 of 16 keywords
sdkContextSchema16 of 16 keywords
1715129{
21n/a "additionalProperties": true,
3720119 "properties": {
479341 "appName": {
579328 "minLength": 1,
682113 "type": "string"
779341 },
823223 "currentTime": {
92326 "format": "date-time",
1023817 "type": "string"
1123223 },
1223812 "environment": {
1323812 "type": "string"
1423812 },
1523217 "properties": {
1617812 "additionalProperties": {
1744036 "type": "string"
1817812 },
192445 "type": "object"
2023217 },
2119919 "remoteAddress": {
2219919 "type": "string"
2319919 },
241958 "sessionId": {
251958 "type": "string"
261958 },
2721819 "userId": {
2821819 "type": "string"
2921819 }
30720119 },
318345 "required": [
328345 "appName"
338345 ],
348395 "type": "object"
35715129}
Responses
codedescriptionhitsavg
200playgroundResponseSchema6892ms
400The request data does not match what we expect.2001ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
500Internal Server Error42ms
Examples
Body: application/json
"My cool application."sdkContextSchema.appName
"2022-07-05T12:56:41+02:00"sdkContextSchema.currentTime
{ "customContextField": "this is one!", "otherCustomField": "3" }sdkContextSchema
"192.168.1.1"sdkContextSchema.remoteAddress
"b65e7b23-fec0-4814-a129-0e9861ef18fc"sdkContextSchema.sessionId
"username@provider.com"sdkContextSchema.userId
"development"playgroundRequestSchema.environment
[ "my-project" ]playgroundRequestSchema.projects
Body
application/json28 / 28
advancedPlaygroundRequestSchema
#validinvalidschema
1658208{
2666189 "properties": {
3727127 "context": {
5727127 },
678662 "environments": {
778739 "items": {
812154 "minLength": 1,
9118633 "pattern": "^[a-zA-Z0-9~_.-]+$",
1012199 "type": "string"
1178739 },
128251 "minItems": 1,
1382622 "type": "array"
1478662 },
1523629 "projects": {
1623629 "oneOf": [
1719768 {
181978 "items": {
1921037 "type": "string"
201978 },
2120560 "type": "array"
2219768 },
2339226 {
2439226 "enum": [
2539n/a "*"
2639226 ],
2741224 "type": "string"
2839226 }
2923629 ]
3023629 }
31666189 },
3284713 "required": [
3384812 "environments",
348546 "context"
3584713 ],
368606 "type": "object"
37658208}
Referenced Components (1)16 of 16 keywords
sdkContextSchema16 of 16 keywords
1727127{
21n/a "additionalProperties": true,
3729120 "properties": {
481928 "appName": {
581918 "minLength": 1,
683710 "type": "string"
781928 },
821718 "currentTime": {
921713 "format": "date-time",
102305 "type": "string"
1121718 },
1221923 "environment": {
1321923 "type": "string"
1421923 },
1522029 "properties": {
1616815 "additionalProperties": {
1738322 "type": "string"
1816815 },
1923514 "type": "object"
2022029 },
212267 "remoteAddress": {
222267 "type": "string"
232267 },
2419313 "sessionId": {
2519313 "type": "string"
2619313 },
2721522 "userId": {
2821522 "type": "string"
2921522 }
30729120 },
318472 "required": [
328472 "appName"
338472 ],
348495 "type": "object"
35727127}
Responses
codedescriptionhitsavg
200advancedPlaygroundResponseSchema7003ms
400The request data does not match what we expect.2021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
Examples
Body: application/json
"My cool application."sdkContextSchema.appName
"2022-07-05T12:56:41+02:00"sdkContextSchema.currentTime
{ "customContextField": "this is one!", "otherCustomField": "3" }sdkContextSchema
"192.168.1.1"sdkContextSchema.remoteAddress
"b65e7b23-fec0-4814-a129-0e9861ef18fc"sdkContextSchema.sessionId
"username@provider.com"sdkContextSchema.userId
[ "development", "production" ]advancedPlaygroundRequestSchema.environments
[ "my-project" ]advancedPlaygroundRequestSchema.projects
Projects 17 operations 17 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200personalDashboardSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error8031ms
Path Parameters
projectId1 / 1
#validinvalidschema
1848n/a{
2848n/a "type": "string"
3848n/a}
Responses
codedescriptionhitsavg
200personalDashboardProjectDetailsSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.431ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error8052ms
Query Parameters
archived1 / 1
#validinvalidschema
1507669{
2507669 "type": "boolean"
3507669}
Responses
codedescriptionhitsavg
200projectsSchema10274ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6691ms
Path Parameters
projectId1 / 1
#validinvalidschema
1820n/a{
2820n/a "type": "string"
3820n/a}
Responses
codedescriptionhitsavg
200apiTokensSchema7545ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.631ms
Path Parameters
projectId1 / 1
#validinvalidschema
1874n/a{
2874n/a "type": "string"
3874n/a}
Body
application/json9 / 9
createProjectApiTokenSchema
1627165{
2652116 "properties": {
316520 "environment": {
416520 "type": "string"
516520 },
613743 "expiresAt": {
713710 "format": "date-time",
814733 "type": "string"
913743 },
1070749 "tokenName": {
1170749 "type": "string"
1270749 },
1369659 "type": {
1469645 "pattern": "^([Cc][Ll][Ii][Ee][Nn][Tt]|[Bb][Aa][Cc][Kk][Ee][Nn][Dd]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$",
1574114 "type": "string"
1669659 }
17652116 },
1874328 "required": [
1975615 "tokenName",
2075516 "type"
2174328 ],
2277121 "type": "object"
23627165}
Responses
codedescriptionhitsavg
201The resource was successfully created.5375ms
400The request data does not match what we expect.3021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.291ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
Examples
Body: application/json
"default"createProjectApiTokenSchema.environment
"development"createProjectApiTokenSchema.environment
"2023-10-01T00:00:00Z"createProjectApiTokenSchema.expiresAt
"some-user"createProjectApiTokenSchema.tokenName
"frontend"createProjectApiTokenSchema.type
Path Parameters
projectId1 / 1
#validinvalidschema
1532n/a{
2532n/a "type": "string"
3532n/a}
token1 / 1
1532n/a{
2532n/a "type": "string"
3532n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
400The request data does not match what we expect.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.5322ms
Path Parameters
projectId1 / 1
#validinvalidschema
1840n/a{
2840n/a "type": "string"
3840n/a}
Query Parameters
query1 / 1
1223n/a{
2223n/a "type": "string"
3223n/a}
offset1 / 1
1186n/a{
2186n/a "type": "string"
3186n/a}
limit1 / 1
1218n/a{
2218n/a "type": "string"
3218n/a}
sortBy1 / 1
1197n/a{
2197n/a "type": "string"
3197n/a}
sortOrder1 / 1
1183n/a{
2183n/a "type": "string"
3183n/a}
Responses
codedescriptionhitsavg
200projectApplicationsSchema8371ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Examples
Query
"first_app"query
"50"offset
"50"limit
"type"sortBy
"desc"sortOrder
Path Parameters
projectId1 / 1
#validinvalidschema
1823n/a{
2823n/a "type": "string"
3823n/a}
Responses
codedescriptionhitsavg
200projectDoraMetricsSchema8202ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
11060n/a{
21060n/a "type": "string"
31060n/a}
Body
application/json52 / 52
projectEnvironmentSchema
1603362{
2n/a0 "additionalProperties": false,
3609324 "properties": {
45646 "changeRequestsEnabled": {
55646 "type": "boolean"
65646 },
7365314 "defaultStrategy": {
9365314 },
1088938 "environment": {
1188938 "type": "string"
1288938 }
13609324 },
1492732 "required": [
1592732 "environment"
1692732 ],
179596 "type": "object"
18603362}
Referenced Components (4)57 of 57 keywords
constraintSchema15 of 15 keywords
11103471{
2n/a0 "additionalProperties": false,
31105463 "properties": {
4786191 "caseInsensitive": {
5786191 "type": "boolean"
6786191 },
71438129 "contextName": {
81438129 "type": "string"
91438129 },
108839 "inverted": {
118839 "type": "boolean"
128839 },
1315616 "operator": {
1415616 "enum": [
1559n/a "NOT_IN",
16450n/a "IN",
1755n/a "STR_ENDS_WITH",
1830n/a "STR_STARTS_WITH",
1996n/a "STR_CONTAINS",
2066n/a "NUM_EQ",
2168n/a "NUM_GT",
2271n/a "NUM_GTE",
2332n/a "NUM_LT",
2487n/a "NUM_LTE",
25105n/a "DATE_AFTER",
2649n/a "DATE_BEFORE",
2785n/a "SEMVER_EQ",
2871n/a "SEMVER_GT",
2935n/a "SEMVER_LT",
3094n/a "SEMVER_GTE",
3155n/a "SEMVER_LTE",
3253n/a "REGEX"
3315616 ],
3415625 "type": "string"
3515616 },
36600118 "value": {
37600101 "minLength": 1,
3870117 "type": "string"
39600118 },
4085010 "values": {
418505 "items": {
4232815 "type": "string"
438505 },
448555 "type": "array"
4585010 }
461105463 },
4715662 "required": [
4815671 "contextName",
4915671 "operator"
5015662 ],
5115686 "type": "object"
521103471}
createFeatureStrategySchema18 of 18 keywords
1365314{
2368299 "properties": {
3391182 "constraints": {
4391177 "items": {
6391177 },
75685 "type": "array"
8391182 },
944911 "disabled": {
10460n/a "nullable": true,
1144911 "type": "boolean"
1244911 },
136568 "name": {
146568 "type": "string"
156568 },
1644110 "parameters": {
18 "example": {
19 "groupId": "some_new",
20 "rollout": "25",
21 "stickiness": "sessionId"
22 }
2344110 },
2437123 "segments": {
2537118 "items": {
26116392 "type": "number"
2737118 },
283895 "type": "array"
2937123 },
3035511 "sortOrder": {
3135511 "type": "number"
3235511 },
3338840 "title": {
34428n/a "nullable": true,
3538840 "type": "string"
3638840 },
37320105 "variants": {
38320100 "items": {
40320100 },
414205 "type": "array"
42320105 }
43368299 },
4466410 "required": [
4566410 "name"
4666410 ],
476745 "type": "object"
48365314}
createStrategyVariantSchema22 of 22 keywords
1591311{
2596301 "properties": {
38915 "name": {
48915 "type": "string"
58915 },
6307275 "payload": {
753318 "properties": {
83188 "type": {
93188 "enum": [
1084n/a "json",
1183n/a "csv",
1278n/a "string",
1373n/a "number"
143188 ],
153215 "type": "string"
163188 },
1754010 "value": {
1854010 "type": "string"
1954010 }
2053318 },
21325226 "required": [
22326225 "type",
235501 "value"
24325226 ],
2555131 "type": "object"
26307275 },
278905 "stickiness": {
288905 "type": "string"
298905 },
3086135 "weight": {
318641 "maximum": 1000,
328632 "minimum": 0,
3386432 "type": "integer"
3486135 },
358887 "weightType": {
368887 "enum": [
37350n/a "variable",
38538n/a "fix"
398887 ],
408905 "type": "string"
418887 }
42596301 },
438925 "required": [
448961 "name",
458961 "weight",
468952 "weightType",
478952 "stickiness"
488925 ],
498975 "type": "object"
50591311}
parametersSchema2 of 2 keywords
144110{
21765 "additionalProperties": {
34365 "type": "string"
41765 },
54465 "type": "object"
644110}
Responses
codedescriptionhitsavg
200This response has no body.1110ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.3272ms
Undocumented - not in spec
codedescriptionhitsavg
41531ms
400Bad Request6911ms
404Not Found251ms
Examples
Body: application/json
trueprojectEnvironmentSchema.changeRequestsEnabled
[ { "caseInsensitive": false, "contextName": "appName", "inverted": false, "operator": "IN", "values": [ "1", "2" ] } ]createFeatureStrategySchema.constraints
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
falsecreateFeatureStrategySchema.disabled
"flexibleRollout"createFeatureStrategySchema.name
[ 1, 2 ]createFeatureStrategySchema.segments
9999createFeatureStrategySchema.sortOrder
"Gradual Rollout 25-Prod"createFeatureStrategySchema.title
"blue_group"createStrategyVariantSchema.name
{ "type": "json", "value": "{\"color\": \"red\"}" }createStrategyVariantSchema.payload
"custom.context.field"createStrategyVariantSchema.stickiness
"fix"createStrategyVariantSchema.weightType
"development"projectEnvironmentSchema.environment
Path Parameters
projectId1 / 1
#validinvalidschema
1227n/a{
2227n/a "type": "string"
3227n/a}
environment1 / 1
1227n/a{
2227n/a "type": "string"
3227n/a}
Responses
codedescriptionhitsavg
200This response has no body.2244ms
400The request data does not match what we expect.0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
11037n/a{
21037n/a "type": "string"
31037n/a}
environment1 / 1
11037n/a{
21037n/a "type": "string"
31037n/a}
Body
application/json46 / 46
createFeatureStrategySchema
1311259{
2324238 "properties": {
329498 "constraints": {
429493 "items": {
629493 },
73875 "type": "array"
829498 },
932423 "disabled": {
10347n/a "nullable": true,
1132423 "type": "boolean"
1232423 },
135436 "name": {
145436 "type": "string"
155436 },
1633727 "parameters": {
18 "example": {
19 "groupId": "some_new",
20 "rollout": "25",
21 "stickiness": "sessionId"
22 }
2333727 },
2434012 "segments": {
253406 "items": {
2610738 "type": "number"
273406 },
283466 "type": "array"
2934012 },
303116 "sortOrder": {
313116 "type": "number"
323116 },
333295 "title": {
34334n/a "nullable": true,
353295 "type": "string"
363295 },
37264111 "variants": {
3826498 "items": {
4026498 },
4136213 "type": "array"
42264111 }
43324238 },
4454916 "required": [
4554916 "name"
4654916 ],
475655 "type": "object"
48311259}
Referenced Components (3)39 of 39 keywords
constraintSchema15 of 15 keywords
1744342{
2n/a0 "additionalProperties": false,
3757219 "properties": {
454612 "caseInsensitive": {
554612 "type": "boolean"
654612 },
79595 "contextName": {
89595 "type": "string"
99595 },
1058855 "inverted": {
1158855 "type": "boolean"
1258855 },
1395025 "operator": {
1495025 "enum": [
1561n/a "NOT_IN",
16212n/a "IN",
1731n/a "STR_ENDS_WITH",
1829n/a "STR_STARTS_WITH",
1959n/a "STR_CONTAINS",
2045n/a "NUM_EQ",
2151n/a "NUM_GT",
2266n/a "NUM_GTE",
2351n/a "NUM_LT",
2430n/a "NUM_LTE",
2559n/a "DATE_AFTER",
2623n/a "DATE_BEFORE",
2729n/a "SEMVER_EQ",
2841n/a "SEMVER_GT",
2934n/a "SEMVER_LT",
3050n/a "SEMVER_GTE",
3140n/a "SEMVER_LTE",
3239n/a "REGEX"
3395025 ],
349705 "type": "string"
3595025 },
3644416 "value": {
374445 "minLength": 1,
3844911 "type": "string"
3944416 },
40495113 "values": {
4149548 "items": {
422114210 "type": "string"
4349548 },
4454365 "type": "array"
45495113 }
46757219 },
4796313 "required": [
4896412 "contextName",
499751 "operator"
5096313 ],
51976110 "type": "object"
52744342}
createStrategyVariantSchema22 of 22 keywords
1545209{
2576173 "properties": {
373512 "name": {
473512 "type": "string"
573512 },
631696 "payload": {
731988 "properties": {
837233 "type": {
937233 "enum": [
10118n/a "json",
1175n/a "csv",
1264n/a "string",
13115n/a "number"
1437233 ],
154005 "type": "string"
1637233 },
1735155 "value": {
1835155 "type": "string"
1935155 }
2031988 },
214043 "required": [
224052 "type",
234061 "value"
244043 ],
254075 "type": "object"
2631696 },
2773414 "stickiness": {
2873414 "type": "string"
2973414 },
3070345 "weight": {
3172513 "maximum": 1000,
3271721 "minimum": 0,
3373711 "type": "integer"
3470345 },
3568537 "weightType": {
3668537 "enum": [
37307n/a "variable",
38378n/a "fix"
3968537 ],
407175 "type": "string"
4168537 }
42576173 },
4371831 "required": [
447472 "name",
457481 "weight",
4672227 "weightType",
477481 "stickiness"
4871831 ],
497495 "type": "object"
50545209}
parametersSchema2 of 2 keywords
133727{
211720 "additionalProperties": {
332742 "type": "string"
411720 },
53577 "type": "object"
633727}
Responses
codedescriptionhitsavg
200createFeatureStrategySchema963ms
400The request data does not match what we expect.9351ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
41531ms
Examples
Body: application/json
[ { "caseInsensitive": false, "contextName": "appName", "inverted": false, "operator": "IN", "values": [ "1", "2" ] } ]createFeatureStrategySchema.constraints
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
falsecreateFeatureStrategySchema.disabled
"flexibleRollout"createFeatureStrategySchema.name
[ 1, 2 ]createFeatureStrategySchema.segments
9999createFeatureStrategySchema.sortOrder
"Gradual Rollout 25-Prod"createFeatureStrategySchema.title
"blue_group"createStrategyVariantSchema.name
{ "type": "json", "value": "{\"color\": \"red\"}" }createStrategyVariantSchema.payload
"custom.context.field"createStrategyVariantSchema.stickiness
"fix"createStrategyVariantSchema.weightType
Path Parameters
projectId1 / 1
#validinvalidschema
1822n/a{
2822n/a "type": "string"
3822n/a}
Responses
codedescriptionhitsavg
200projectFlagCreatorsSchema8191ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Path Parameters
projectId1 / 1
#validinvalidschema
1834n/a{
2834n/a "type": "string"
3834n/a}
Responses
codedescriptionhitsavg
200healthReportSchema6642ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.841ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error832ms
Path Parameters
projectId1 / 1
#validinvalidschema
1830n/a{
2830n/a "type": "string"
3830n/a}
Responses
codedescriptionhitsavg
200projectInsightsSchema6483ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.891ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error902ms
Path Parameters
projectId1 / 1
#validinvalidschema
1823n/a{
2823n/a "type": "string"
3823n/a}
Responses
codedescriptionhitsavg
200projectOverviewSchema7582ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.621ms
Path Parameters
projectId1 / 1
#validinvalidschema
1820n/a{
2820n/a "type": "string"
3820n/a}
Responses
codedescriptionhitsavg
200outdatedSdksSchema8171ms
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Path Parameters
projectId1 / 1
#validinvalidschema
1831n/a{
2831n/a "type": "string"
3831n/a}
Responses
codedescriptionhitsavg
200projectStatusSchema8282ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Public signup tokens 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json6 / 6
publicSignupTokenCreateSchema
#validinvalidschema
1714147{
2n/a0 "additionalProperties": false,
374291 "properties": {
475775 "expiresAt": {
575740 "format": "date-time",
679735 "type": "string"
775775 },
874462 "name": {
974462 "type": "string"
1074462 }
1174291 },
1280535 "required": [
1380634 "name",
148328 "expiresAt"
1580535 ],
1684021 "type": "object"
17714147}
Responses
codedescriptionhitsavg
201The resource was successfully created.7235ms
400The request data does not match what we expect.1941ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
500Internal Server Error22ms
Path Parameters
token1 / 1
#validinvalidschema
1834n/a{
2834n/a "type": "string"
3834n/a}
Body
application/json7 / 7
createInvitedUserSchema
1199160{
2n/a0 "additionalProperties": false,
324985 "properties": {
424443 "email": {
524443 "type": "string"
624443 },
730526 "name": {
830526 "type": "string"
930526 },
1030527 "password": {
1130527 "type": "string"
1230527 },
1310744 "username": {
1410744 "type": "string"
1510744 }
1624985 },
1728456 "required": [
1828753 "email",
193319 "name",
203328 "password"
2128456 ],
2234019 "type": "object"
23199160}
Responses
codedescriptionhitsavg
200userSchema0never seen
400The request data does not match what we expect.8311ms
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.0never seen
Undocumented - not in spec
codedescriptionhitsavg
41531ms
Examples
Body: application/json
"hunter@example.com"createInvitedUserSchema.email
"Hunter Burgan"createInvitedUserSchema.name
"hunter2"createInvitedUserSchema.password
"Hunter"createInvitedUserSchema.username
Path Parameters
token1 / 1
#validinvalidschema
1802n/a{
2802n/a "type": "string"
3802n/a}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
400The request data does not match what we expect.8021ms
Segments 8 operations 8 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200segmentsSchema17631ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Body
application/json22 / 22
upsertSegmentSchema
#validinvalidschema
11501283{
21528243 "properties": {
31559209 "constraints": {
41559189 "items": {
61559189 },
7174820 "type": "array"
81559209 },
987036 "description": {
10906n/a "nullable": true,
1187036 "type": "string"
1287036 },
13172621 "name": {
14172621 "type": "string"
15172621 },
1673831 "project": {
17769n/a "nullable": true,
1873831 "type": "string"
1973831 }
201528243 },
21174430 "required": [
22174727 "name",
2317686 "constraints"
24174430 ],
25177410 "type": "object"
261501283}
Referenced Components (1)15 of 15 keywords
constraintSchema15 of 15 keywords
17257499{
2n/a0 "additionalProperties": false,
37272475 "properties": {
4419151 "caseInsensitive": {
5419151 "type": "boolean"
6419151 },
77628105 "contextName": {
87628105 "type": "string"
97628105 },
10397699 "inverted": {
11397699 "type": "boolean"
12397699 },
137639107 "operator": {
147639107 "enum": [
15362n/a "NOT_IN",
16796n/a "IN",
17395n/a "STR_ENDS_WITH",
18337n/a "STR_STARTS_WITH",
19395n/a "STR_CONTAINS",
20434n/a "NUM_EQ",
21320n/a "NUM_GT",
22481n/a "NUM_GTE",
23442n/a "NUM_LT",
24431n/a "NUM_LTE",
25466n/a "DATE_AFTER",
26414n/a "DATE_BEFORE",
27406n/a "SEMVER_EQ",
28438n/a "SEMVER_GT",
29399n/a "SEMVER_LT",
30458n/a "SEMVER_GTE",
31271n/a "SEMVER_LTE",
32394n/a "REGEX"
337639107 ],
3477415 "type": "string"
357639107 },
36386942 "value": {
37386924 "minLength": 1,
38389318 "type": "string"
39386942 },
40386193 "values": {
41386148 "items": {
4219142234 "type": "string"
43386148 },
44390945 "type": "array"
45386193 }
467272475 },
47773215 "required": [
48773314 "contextName",
4977461 "operator"
50773215 ],
5177479 "type": "object"
527257499}
Responses
codedescriptionhitsavg
201The resource was successfully created.1926ms
400The request data does not match what we expect.14101ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.2201ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error552ms
Examples
Body: application/json
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
"Users willing to help us test and build new features."upsertSegmentSchema.description
"beta-users"upsertSegmentSchema.name
"red-vista"upsertSegmentSchema.project
Path Parameters
strategyId1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200segmentsSchema8021ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Body
application/json4 / 4
nameSchema
#validinvalidschema
1247510{
2n/a0 "additionalProperties": false,
3247208 "properties": {
4247208 "name": {
5247208 "type": "string"
6247208 }
7247208 },
845588 "required": [
945588 "name"
1045588 ],
11543214 "type": "object"
12247510}
Responses
codedescriptionhitsavg
204This response has no body.1721ms
400The request data does not match what we expect.5731ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.661ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error21ms
Examples
Body: application/json
"betaUser"nameSchema.name
Path Parameters
id1 / 1
#validinvalidschema
12245{
22245 "type": "integer"
32245}
Responses
codedescriptionhitsavg
204This response has no body.1756ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.21ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request50ms
404Not Found441ms
Path Parameters
id1 / 1
#validinvalidschema
1780132{
2780132 "type": "integer"
3780132}
Responses
codedescriptionhitsavg
200adminSegmentSchema6901ms
404The requested resource was not found.751ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1261ms
401Unauthorized31ms
500Internal Server Error181ms
Path Parameters
id1 / 1
#validinvalidschema
198124{
298124 "type": "integer"
398124}
Body
application/json22 / 22
upsertSegmentSchema
1812138{
2836109 "properties": {
385490 "constraints": {
485477 "items": {
685477 },
793113 "type": "array"
885490 },
927920 "description": {
10299n/a "nullable": true,
1127920 "type": "string"
1227920 },
1391012 "name": {
1491012 "type": "string"
1591012 },
1626221 "project": {
17283n/a "nullable": true,
1826221 "type": "string"
1926221 }
20836109 },
2192124 "required": [
2292223 "name",
239441 "constraints"
2492124 ],
259455 "type": "object"
26812138}
Referenced Components (1)15 of 15 keywords
constraintSchema15 of 15 keywords
11474149{
2n/a0 "additionalProperties": false,
31480129 "properties": {
48125 "caseInsensitive": {
58125 "type": "boolean"
68125 },
7154262 "contextName": {
8154262 "type": "string"
9154262 },
108095 "inverted": {
118095 "type": "boolean"
128095 },
13157236 "operator": {
14157236 "enum": [
15107n/a "NOT_IN",
16206n/a "IN",
1797n/a "STR_ENDS_WITH",
18111n/a "STR_STARTS_WITH",
1994n/a "STR_CONTAINS",
2072n/a "NUM_EQ",
2151n/a "NUM_GT",
2255n/a "NUM_GTE",
2382n/a "NUM_LT",
2475n/a "NUM_LTE",
2564n/a "DATE_AFTER",
2640n/a "DATE_BEFORE",
2782n/a "SEMVER_EQ",
2891n/a "SEMVER_GT",
29107n/a "SEMVER_LT",
3066n/a "SEMVER_GTE",
3173n/a "SEMVER_LTE",
3299n/a "REGEX"
33157236 ],
3416035 "type": "string"
35157236 },
3674323 "value": {
3774315 "minLength": 1,
387588 "type": "string"
3974323 },
4075716 "values": {
417575 "items": {
4234315 "type": "string"
437575 },
4476211 "type": "array"
4575716 }
461480129 },
4716036 "required": [
4816045 "contextName",
4916081 "operator"
5016036 ],
51160914 "type": "object"
521474149}
Responses
codedescriptionhitsavg
204This response has no body.2085ms
400The request data does not match what we expect.5041ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.2591ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error172ms
404Not Found111ms
Examples
Body: application/json
falseconstraintSchema.caseInsensitive
"appName"constraintSchema.contextName
falseconstraintSchema.inverted
"IN"constraintSchema.operator
"my-app"constraintSchema.value
[ "my-app", "my-other-app" ]constraintSchema.values
"Users willing to help us test and build new features."upsertSegmentSchema.description
"beta-users"upsertSegmentSchema.name
"red-vista"upsertSegmentSchema.project
Path Parameters
id1 / 1
#validinvalidschema
1700110{
2700110 "type": "integer"
3700110}
Responses
codedescriptionhitsavg
200segmentStrategiesSchema92ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1101ms
404Not Found6671ms
401Unauthorized31ms
500Internal Server Error211ms
Strategies 10 operations 10 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
contextField1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200contextFieldStrategiesSchema8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Path Parameters
projectId1 / 1
#validinvalidschema
1833n/a{
2833n/a "type": "string"
3833n/a}
contextField1 / 1
1833n/a{
2833n/a "type": "string"
3833n/a}
Responses
codedescriptionhitsavg
200contextFieldStrategiesSchema8301ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Body
application/json9 / 9
updateFeatureStrategySegmentsSchema
#validinvalidschema
1690126{
2702102 "properties": {
377922 "environmentId": {
477922 "type": "string"
577922 },
676832 "projectId": {
776832 "type": "string"
876832 },
974852 "segmentIds": {
1074816 "items": {
1199816 "minimum": 0,
12101324 "type": "integer"
1374816 },
1476436 "type": "array"
1574852 },
1675053 "strategyId": {
1775053 "type": "string"
1875053 }
19702102 },
2079217 "required": [
218009 "projectId",
228036 "strategyId",
238018 "environmentId",
248009 "segmentIds"
2579217 ],
268097 "type": "object"
27690126}
Responses
codedescriptionhitsavg
201The resource was successfully created.5751ms
400The request data does not match what we expect.1921ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error732ms
Examples
Body: application/json
"development"updateFeatureStrategySegmentsSchema.environmentId
"red-vista"updateFeatureStrategySegmentsSchema.projectId
[ 1, 5, 6 ]updateFeatureStrategySegmentsSchema.segmentIds
"15d1e20b-6310-4e17-a0c2-9fb84de3053a"updateFeatureStrategySegmentsSchema.strategyId
Responses
codedescriptionhitsavg
200strategiesSchema17981ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Body
application/json17 / 17
createStrategySchema
#validinvalidschema
11450329{
21482276 "properties": {
373233 "deprecated": {
473233 "type": "boolean"
573233 },
669928 "description": {
769928 "type": "string"
869928 },
970623 "editable": {
1070623 "type": "boolean"
1170623 },
12164385 "name": {
13164385 "type": "string"
14164385 },
151600156 "parameters": {
161600131 "items": {
175618146 "properties": {
18282432 "description": {
19282432 "type": "string"
20282432 },
21571023 "name": {
22571023 "type": "string"
23571023 },
24282252 "required": {
25282252 "type": "boolean"
26282252 },
27570261 "type": {
28570261 "enum": [
291065n/a "string",
301060n/a "percentage",
311458n/a "list",
321122n/a "number",
33997n/a "boolean"
34570261 ],
3557585 "type": "string"
36570261 }
375618146 },
38573232 "required": [
39573331 "name",
4057631 "type"
41573232 ],
42576419 "type": "object"
431600131 },
44173125 "type": "array"
451600156 },
4665118 "title": {
4765118 "type": "string"
4865118 }
491482276 },
50172640 "required": [
51172838 "name",
52175610 "parameters"
53172640 ],
54176613 "type": "object"
551450329}
Responses
codedescriptionhitsavg
201The resource was successfully created.2026ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.4111ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request12281ms
Examples
Body: application/json
truecreateStrategySchema.deprecated
"Enable the feature for users who have not logged in before."createStrategySchema.description
falsecreateStrategySchema.editable
"my-custom-strategy"createStrategySchema.name
"How many percent of users should see this feature?"createStrategySchema.parameters.description
"Rollout percentage"createStrategySchema.parameters.name
falsecreateStrategySchema.parameters.required
"percentage"createStrategySchema.parameters.type
"My awesome strategy"createStrategySchema.title
Path Parameters
name1 / 1
#validinvalidschema
1295n/a{
2295n/a "type": "string"
3295n/a}
Responses
codedescriptionhitsavg
200This response has no body.1825ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.521ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error581ms
Path Parameters
name1 / 1
#validinvalidschema
1974n/a{
2974n/a "type": "string"
3974n/a}
Responses
codedescriptionhitsavg
200strategySchema8651ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
404The requested resource was not found.1061ms
Path Parameters
name1 / 1
#validinvalidschema
11012n/a{
21012n/a "type": "string"
31012n/a}
Body
application/json13 / 13
updateStrategySchema
188674{
289058 "properties": {
32516 "description": {
42516 "type": "string"
52516 },
689252 "parameters": {
789247 "items": {
8145147 "properties": {
996822 "description": {
1096822 "type": "string"
1196822 },
12148011 "name": {
13148011 "type": "string"
14148011 },
1510345 "required": {
1610345 "type": "boolean"
1710345 },
18147126 "type": {
19147126 "enum": [
20326n/a "string",
21278n/a "percentage",
22457n/a "list",
23115n/a "number",
24295n/a "boolean"
25147126 ],
2614925 "type": "string"
27147126 }
28145147 },
2914908 "required": [
3014917 "name",
3114971 "type"
3214908 ],
3314985 "type": "object"
3489247 },
359395 "type": "array"
3689252 }
3789058 },
3894411 "required": [
3994411 "parameters"
4094411 ],
419555 "type": "object"
4288674}
Responses
codedescriptionhitsavg
200This response has no body.7315ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.281ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1551ms
500Internal Server Error921ms
Examples
Body: application/json
"Enable the feature for users who have not logged in before."updateStrategySchema.description
"How many percent of users should see this feature?"updateStrategySchema.parameters.description
"Rollout percentage"updateStrategySchema.parameters.name
falseupdateStrategySchema.parameters.required
"percentage"updateStrategySchema.parameters.type
Path Parameters
strategyName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200This response has no body.6084ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.1941ms
Path Parameters
strategyName1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200This response has no body.6474ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.1551ms
Tags 12 operations 12 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
projectId1 / 1
#validinvalidschema
1947n/a{
2947n/a "type": "string"
3947n/a}
Body
application/json26 / 26
tagsBulkAddSchema
1402460{
2n/a0 "additionalProperties": false,
3450391 "properties": {
4696106 "features": {
569639 "items": {
62124125 "minLength": 1,
7224985 "type": "string"
869639 },
973567 "type": "array"
10696106 },
11467365 "tags": {
13467365 }
14450391 },
1579361 "required": [
1680252 "features",
1783222 "tags"
1879361 ],
198548 "type": "object"
20402460}
Referenced Components (2)23 of 23 keywords
tagSchema14 of 14 keywords
121451667{
2n/a3 "additionalProperties": false,
321811209 "properties": {
41277701 "color": {
51978n/a "nullable": true,
6619134 "pattern": "^#[0-9A-Fa-f]{6}$",
71411567 "type": "string"
81277701 },
92646714 "type": {
102731107 "maxLength": 50,
11275385 "minLength": 2,
122838522 "type": "string"
132646714 },
143126258 "value": {
15317057 "maxLength": 50,
16318344 "minLength": 2,
173227157 "type": "string"
183126258 }
1921811209 },
20335443 "required": [
21338413 "value",
22336037 "type"
23335443 ],
243397415 "type": "object"
2521451667}
updateTagsSchema9 of 9 keywords
1467365{
2n/a0 "additionalProperties": false,
3496321 "properties": {
4524269 "addedTags": {
5524242 "items": {
7524242 },
876627 "type": "array"
9524269 },
10553259 "removedTags": {
11553214 "items": {
13553214 },
1476745 "type": "array"
15553259 }
16496321 },
1778830 "required": [
1879325 "addedTags",
198126 "removedTags"
2078830 ],
2181814 "type": "object"
22467365}
Responses
codedescriptionhitsavg
200This response has no body.2271ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6711ms
500Internal Server Error432ms
Examples
Body: application/json
{ "addedTags": [ { "type": "simple", "value": "tag-to-add" } ], "removedTags": [ { "type": "simple", "value": "tag-to-remove" } ] }updateTagsSchema
"#FFFFFF"tagSchema.color
"simple"tagSchema.type
"a-tag-value"tagSchema.value
Responses
codedescriptionhitsavg
200tagTypesSchema17381ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Body
application/json10 / 10
tagTypeSchema
#validinvalidschema
11210359{
2n/a0 "additionalProperties": false,
31255264 "properties": {
4694100 "color": {
5794n/a "nullable": true,
654220 "pattern": "^#[0-9A-Fa-f]{6}$",
771480 "type": "string"
8694100 },
961285 "description": {
1061285 "type": "string"
1161285 },
12525177 "icon": {
13702n/a "nullable": true,
14525177 "type": "string"
15525177 },
161349125 "name": {
171349125 "type": "string"
181349125 }
191255264 },
20147481 "required": [
21147481 "name"
22147481 ],
23155514 "type": "object"
241210359}
Responses
codedescriptionhitsavg
201The resource was successfully created.2334ms
400The request data does not match what we expect.10931ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.3441ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Examples
Body: application/json
"#FFFFFF"tagTypeSchema.color
"A tag type for describing the color of a tag."tagTypeSchema.description
"not-really-used"tagTypeSchema.icon
"color"tagTypeSchema.name
Body
application/json10 / 10
tagTypeSchema
#validinvalidschema
11137304{
2n/a0 "additionalProperties": false,
31184214 "properties": {
4581116 "color": {
5697n/a "nullable": true,
646444 "pattern": "^#[0-9A-Fa-f]{6}$",
762572 "type": "string"
8581116 },
954554 "description": {
1054554 "type": "string"
1154554 },
12542103 "icon": {
13645n/a "nullable": true,
14542103 "type": "string"
15542103 },
161251100 "name": {
171251100 "type": "string"
181251100 }
191184214 },
20135175 "required": [
21135175 "name"
22135175 ],
23142615 "type": "object"
241137304}
Responses
codedescriptionhitsavg
200validateTagTypeSchema4401ms
400The request data does not match what we expect.9791ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.1711ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Examples
Body: application/json
"#FFFFFF"tagTypeSchema.color
"A tag type for describing the color of a tag."tagTypeSchema.description
"not-really-used"tagTypeSchema.icon
"color"tagTypeSchema.name
Path Parameters
name1 / 1
#validinvalidschema
1418n/a{
2418n/a "type": "string"
3418n/a}
Responses
codedescriptionhitsavg
200This response has no body.2003ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2151ms
Path Parameters
name1 / 1
#validinvalidschema
11086n/a{
21086n/a "type": "string"
31086n/a}
Responses
codedescriptionhitsavg
200tagTypeSchema8641ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2191ms
Path Parameters
name1 / 1
#validinvalidschema
11019n/a{
21019n/a "type": "string"
31019n/a}
Body
application/json6 / 6
updateTagTypeSchema
1769126{
2562104 "properties": {
326773 "color": {
426743 "pattern": "^#[0-9A-Fa-f]{6}$",
531030 "type": "string"
626773 },
739455 "description": {
839455 "type": "string"
939455 },
1030449 "icon": {
1130449 "type": "string"
1230449 }
13562104 },
1487322 "type": "object"
15769126}
Responses
codedescriptionhitsavg
200This response has no body.5683ms
400The request data does not match what we expect.2521ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1931ms
Examples
Body: application/json
"#FFFFFF"updateTagTypeSchema.color
"A tag type for describing the color of a tag."updateTagTypeSchema.description
"not-really-used"updateTagTypeSchema.icon
Responses
codedescriptionhitsavg
200tagsSchema8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Body
application/json11 / 11
createTagSchema
#validinvalidschema
1221207{
2n/a0 "additionalProperties": false,
3233160 "properties": {
4141109 "color": {
5250n/a "nullable": true,
611627 "pattern": "^#[0-9A-Fa-f]{6}$",
716882 "type": "string"
8141109 },
930484 "type": {
1032013 "maxLength": 50,
1131716 "minLength": 2,
1233355 "type": "string"
1330484 },
1432063 "value": {
1532018 "pattern": "^\\s*\\S.{0,48}\\S\\s*$",
1633845 "type": "string"
1732063 }
18233160 },
1938121 "required": [
2038319 "value",
2138814 "type"
2238121 ],
2340226 "type": "object"
24221207}
Responses
codedescriptionhitsavg
201The resource was successfully created.84ms
400The request data does not match what we expect.6411ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
409The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.151ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1712ms
Examples
Body: application/json
"#FFFFFF"createTagSchema.color
"simple"createTagSchema.type
"a-tag-value"createTagSchema.value
Path Parameters
type1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200tagsSchema8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Path Parameters
type1 / 1
#validinvalidschema
1805n/a{
2805n/a "type": "string"
3805n/a}
value1 / 1
1805n/a{
2805n/a "type": "string"
3805n/a}
Responses
codedescriptionhitsavg
200This response has no body.8022ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Path Parameters
type1 / 1
#validinvalidschema
1802n/a{
2802n/a "type": "string"
3802n/a}
value1 / 1
1802n/a{
2802n/a "type": "string"
3802n/a}
Responses
codedescriptionhitsavg
200tagWithVersionSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.8021ms
Telemetry 1 operation 1 covered 0 partial 0 uncovered 0 not measured — #
Responses
codedescriptionhitsavg
200telemetrySettingsSchema8021ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Unknown Flags 1 operation 1 covered 0 partial 0 uncovered 0 not measured — #
Responses
codedescriptionhitsavg
200unknownFlagsResponseSchema8021ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Unleash Edge 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json97 / 97
bulkMetricsSchema
#validinvalidschema
1365437{
2369428 "properties": {
3610184 "applications": {
4610179 "items": {
6610179 },
77895 "type": "array"
8610184 },
9383192 "impactMetrics": {
10383187 "items": {
12383187 },
135705 "type": "array"
14383192 },
15696100 "metrics": {
1669693 "items": {
1869693 },
197897 "type": "array"
20696100 },
2153516 "seenTokens": {
2253511 "items": {
2361211 "type": "string"
2453511 },
255465 "type": "array"
2653516 }
27369428 },
287934 "required": [
297943 "applications",
307961 "metrics"
317934 ],
327975 "type": "object"
33365437}
Referenced Components (4)111 of 111 keywords
bulkRegistrationSchema31 of 31 keywords
11165275{
21172263 "properties": {
3141911 "appName": {
4141911 "type": "string"
5141911 },
663895 "connectVia": {
763889 "items": {
82492143 "properties": {
92483129 "appName": {
102483129 "type": "string"
112483129 },
12262014 "instanceId": {
13262014 "type": "string"
14262014 }
152492143 },
16261124 "required": [
17261223 "appName",
1826341 "instanceId"
19261124 ],
2026355 "type": "object"
2163889 },
227276 "type": "array"
2363895 },
2414286 "environment": {
2514286 "type": "string"
2614286 },
27141717 "instanceId": {
28141717 "type": "string"
29141717 },
3062617 "interval": {
3162617 "type": "number"
3262617 },
3365314 "projects": {
346539 "items": {
35279032 "type": "string"
366539 },
376625 "type": "array"
3865314 },
3964751 "sdkFlavor": {
4064746 "maxLength": 256,
416935 "type": "string"
4264751 },
4363211 "sdkFlavorVersion": {
446322 "maxLength": 32,
456349 "type": "string"
4663211 },
4765311 "sdkType": {
4865311 "enum": [
49185n/a "frontend",
50189n/a "backend",
51279n/a null
5265311 ],
53664n/a "nullable": true,
546586 "type": "string"
5565311 },
566295 "sdkVersion": {
576295 "type": "string"
586295 },
5963115 "started": {
61 "example": "1952-03-11T12:00:00.000Z"
6263115 },
6358247 "strategies": {
6458221 "items": {
65269265 "type": "string"
6658221 },
6760326 "type": "array"
6858247 }
691172263 },
7014287 "required": [
7114305 "appName",
7214341 "instanceId",
7314341 "environment"
7414287 ],
7514355 "type": "object"
761165275}
clientMetricsEnvSchema16 of 16 keywords
11097135{
21115112 "properties": {
312215 "appName": {
412215 "type": "string"
512215 },
6119520 "environment": {
7119520 "type": "string"
8119520 },
9120319 "featureName": {
10120319 "type": "string"
11120319 },
1256422 "no": {
135651 "minimum": 0,
1456521 "type": "integer"
1556422 },
1658633 "timestamp": {
18 "example": "1926-05-08T12:00:00.000Z"
1958633 },
2055328 "variants": {
2143023 "additionalProperties": {
2214127 "minimum": 0,
23141827 "type": "integer"
2443023 },
255765 "type": "object"
2655328 },
275828 "yes": {
285831 "minimum": 0,
295837 "type": "integer"
305828 }
311115112 },
32120918 "required": [
3312225 "featureName",
3412261 "appName",
35121512 "environment"
36120918 ],
3712275 "type": "object"
381097135}
dateSchema5 of 5 keywords
1121748{
2121748 "oneOf": [
3527738 {
45274 "format": "date-time",
5531734 "type": "string"
6527738 },
7690575 {
8690575 "type": "integer"
9690575 }
10121748 ]
11121748}
impactMetricsSchema59 of 59 keywords
1202241{
2202241 "oneOf": [
390353 {
490348 "properties": {
541026 "help": {
641026 "type": "string"
741026 },
842610 "name": {
942610 "type": "string"
1042610 },
11186250 "samples": {
12186219 "items": {
1347599 "properties": {
1438748 "labels": {
1533120 "additionalProperties": {
1694120 "oneOf": [
17378583 {
18378583 "type": "string"
19378583 },
20563398 {
21563398 "type": "number"
22563398 }
2394120 ]
2433120 },
2540728 "type": "object"
2638748 },
2735351 "value": {
2835351 "type": "number"
2935351 }
3047599 },
31404319 "required": [
32404319 "value"
33404319 ],
34723134 "type": "object"
35186219 },
3640531 "type": "array"
37186250 },
38180256 "type": {
39180256 "enum": [
4092n/a "counter",
4188n/a "gauge"
42180256 ],
4342610 "type": "string"
44180256 }
4590348 },
464308 "required": [
474362 "name",
484362 "help",
494362 "type",
504362 "samples"
514308 ]
5290353 },
53122321 {
54122316 "properties": {
5541026 "help": {
5641026 "type": "string"
5741026 },
5842610 "name": {
5942610 "type": "string"
6042610 },
61185251 "samples": {
62185220 "items": {
63419165 "properties": {
64210107 "buckets": {
6521040 "items": {
6661462 "properties": {
676705 "count": {
686705 "type": "number"
696705 },
7061857 "le": {
7161857 "oneOf": [
72351324 {
73351324 "type": "number"
74351324 },
75267408 {
76267408 "enum": [
77267n/a "+Inf"
78267408 ],
79320355 "type": "string"
80267408 }
8161857 ]
8261857 }
8361462 },
846742 "required": [
856751 "le",
866751 "count"
876742 ],
886765 "type": "object"
8921040 },
9025067 "type": "array"
91210107 },
923125 "count": {
933125 "type": "number"
943125 },
9538748 "labels": {
9633120 "additionalProperties": {
9794120 "oneOf": [
98378583 {
99378583 "type": "string"
100378583 },
101563398 {
102563398 "type": "number"
103563398 }
10494120 ]
10533120 },
10640728 "type": "object"
10738748 },
1082805 "sum": {
1092805 "type": "number"
1102805 }
111419165 },
112283440 "required": [
113317406 "count",
114285438 "sum",
115317406 "buckets"
116283440 ],
117723134 "type": "object"
118185220 },
11940531 "type": "array"
120185251 },
121244192 "type": {
122244192 "enum": [
123244n/a "histogram"
124244192 ],
12542610 "type": "string"
126244192 }
127122316 },
1284308 "required": [
1294362 "name",
1304362 "help",
1314362 "type",
1324362 "samples"
1334308 ]
134122321 }
135202241 ],
1364385 "type": "object"
137202241}
Responses
codedescriptionhitsavg
202This response has no body.0never seen
400The request data does not match what we expect.3741ms
413The request body is larger than what we accept. By default we only accept bodies of 100kB or less0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden8051ms
Examples
Body: application/json
"Ingress load balancer"bulkRegistrationSchema.appName
[ { "appName": "unleash-edge", "instanceId": "edge-pod-bghzv5" } ]bulkRegistrationSchema.connectVia
"development"bulkRegistrationSchema.environment
"application-name-dacb1234"bulkRegistrationSchema.instanceId
10bulkRegistrationSchema.interval
[ "projectA", "projectB" ]bulkRegistrationSchema.projects
"unleash-openfeature-node-provider"bulkRegistrationSchema.sdkFlavor
"1.0.1"bulkRegistrationSchema.sdkFlavorVersion
"backend"bulkRegistrationSchema.sdkType
"unleash-client-java:8.0.0"bulkRegistrationSchema.sdkVersion
"2023-07-27T11:23:44Z"dateSchema
1690449593dateSchema
[ "standard", "gradualRollout" ]bulkRegistrationSchema.strategies
"Counts the number of operations"impactMetricsSchema.help
"my-counter"impactMetricsSchema.name
{ "application": "my-app", "environment": "production" }impactMetricsSchema.samples.labels
10impactMetricsSchema.samples.value
"counter"impactMetricsSchema.type
"Measures request duration"impactMetricsSchema.help
"my-histogram"impactMetricsSchema.name
30impactMetricsSchema.samples.buckets.count
0.5impactMetricsSchema.samples.buckets.le
100impactMetricsSchema.samples.count
{ "application": "my-app", "environment": "production" }impactMetricsSchema.samples.labels
1500impactMetricsSchema.samples.sum
"histogram"impactMetricsSchema.type
"accounting"clientMetricsEnvSchema.appName
"development"clientMetricsEnvSchema.environment
"my.special.feature"clientMetricsEnvSchema.featureName
50clientMetricsEnvSchema.no
{ "variantA": 15, "variantB": 25, "variantC": 5 }clientMetricsEnvSchema.variants
974clientMetricsEnvSchema.yes
Body
application/json14 / 14
edgeEnvironmentProjectsListSchema
#validinvalidschema
1992317{
2992269 "properties": {
3992269 "tokens": {
4992213 "items": {
5n/a0 "additionalProperties": false,
61036173 "nullable": false,
79945365 "properties": {
89921329 "environment": {
91023515 "nullable": false,
109921329 "type": "string"
119921329 },
129952349 "projects": {
139952291 "items": {
14624281499 "type": "string"
159952291 },
161025348 "nullable": false,
171024358 "type": "array"
189952349 }
199945365 },
201024170 "required": [
211025061 "environment",
221030110 "projects"
231024170 ],
2410311123 "type": "object"
25992213 },
2612583 "nullable": false,
27120556 "type": "array"
28992269 }
29992269 },
30126132 "required": [
31126132 "tokens"
32126132 ],
33129316 "type": "object"
34992317}
Responses
codedescriptionhitsavg
200validatedEdgeTokensSchema0never seen
400The request data does not match what we expect.3181ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
413The request body is larger than what we accept. By default we only accept bodies of 100kB or less0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.30ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized10381ms
Examples
Body: application/json
"development"edgeEnvironmentProjectsListSchema.tokens.environment
"default"edgeEnvironmentProjectsListSchema.tokens.projects
Body
application/json5 / 5
tokenStringListSchema
#validinvalidschema
1434331{
2434185 "properties": {
3434185 "tokens": {
4434144 "items": {
52241524 "type": "string"
6434144 },
757841 "type": "array"
8434185 }
9434185 },
10619135 "required": [
11619135 "tokens"
12619135 ],
1375411 "type": "object"
14434331}
Responses
codedescriptionhitsavg
200validatedEdgeTokensSchema4351ms
400The request data does not match what we expect.3671ms
413The request body is larger than what we accept. By default we only accept bodies of 100kB or less0never seen
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.31ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error172ms
Examples
Body: application/json
[ "aproject:development.randomstring", "[]:production.randomstring" ]tokenStringListSchema.tokens
Users 18 operations 18 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200meSchema8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Responses
codedescriptionhitsavg
200usersSchema8022ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Body
application/json13 / 13
createUserSchema
#validinvalidschema
11103259{
2n/a0 "additionalProperties": false,
31149186 "properties": {
462446 "email": {
562446 "type": "string"
662446 },
763344 "name": {
863344 "type": "string"
963344 },
1061528 "password": {
1161528 "type": "string"
1261528 },
13119396 "rootRole": {
14119396 "oneOf": [
15925364 {
1692719 "minimum": 0,
17943346 "type": "integer"
18925364 },
192681021 {
202681021 "enum": [
2174n/a "Admin",
2249n/a "Editor",
2334n/a "Viewer",
2429n/a "Owner",
2536n/a "Member",
2646n/a "Reader"
272681021 ],
28295994 "type": "string"
292681021 }
30119396 ]
31119396 },
3262140 "sendEmail": {
3362140 "type": "boolean"
3462140 },
3564028 "username": {
3664028 "type": "string"
3764028 }
381149186 },
39128961 "required": [
40128961 "rootRole"
41128961 ],
42135012 "type": "object"
431103259}
Responses
codedescriptionhitsavg
201The resource was successfully created.877ms
400The request data does not match what we expect.6591ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
41511ms
429Too Many Requests11461ms
500Internal Server Error52ms
Examples
Body: application/json
"user@example.com"createUserSchema.email
"Sam Seawright"createUserSchema.name
"k!5As3HquUrQ"createUserSchema.password
1createUserSchema.rootRole
"Admin"createUserSchema.rootRole
falsecreateUserSchema.sendEmail
"hunter"createUserSchema.username
Responses
codedescriptionhitsavg
200usersGroupsBaseSchema8022ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
Responses
codedescriptionhitsavg
200adminCountSchema8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Responses
codedescriptionhitsavg
200inactiveUsersSchema8021ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized31ms
Body
application/json6 / 6
idsSchema
#validinvalidschema
1210546{
2n/a0 "additionalProperties": false,
3210380 "properties": {
4210380 "ids": {
5210321 "items": {
61106209 "minimum": 0,
71315912 "type": "number"
8210321 },
953159 "type": "array"
10210380 }
11210380 },
1259055 "required": [
1359055 "ids"
1459055 ],
15645111 "type": "object"
16210546}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
400The request data does not match what we expect.651ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found17ms
429Too Many Requests7581ms
Examples
Body: application/json
[ 12, 212 ]idsSchema.ids
Body
application/json4 / 4
idSchema
#validinvalidschema
1366409{
2n/a0 "additionalProperties": false,
3366315 "properties": {
4366315 "id": {
5366315 "type": "string"
6366315 }
7366315 },
868175 "required": [
968175 "id"
1068175 ],
1175619 "type": "object"
12366409}
Responses
codedescriptionhitsavg
200resetPasswordSchema158ms
400The request data does not match what we expect.611ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.0never seen
Undocumented - not in spec
codedescriptionhitsavg
429Too Many Requests7541ms
Examples
Body: application/json
"user@example.com"idSchema.id
Responses
codedescriptionhitsavg
200This response has no body.8021ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Body
application/json6 / 6
passwordSchema
#validinvalidschema
1176201{
2n/a0 "additionalProperties": false,
3210131 "properties": {
412590 "confirmPassword": {
512590 "type": "string"
612590 },
79885 "oldPassword": {
89885 "type": "string"
99885 },
1021889 "password": {
1121889 "type": "string"
1221889 }
13210131 },
1430756 "required": [
1530756 "password"
1630756 ],
1736314 "type": "object"
18176201}
Responses
codedescriptionhitsavg
200This response has no body.17ms
400The request data does not match what we expect.4520ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
415The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
429Too Many Requests3761ms
Examples
Body: application/json
"k!5As3HquUrQ"passwordSchema.confirmPassword
"Oldk!5As3HquUrQ"passwordSchema.oldPassword
"k!5As3HquUrQ"passwordSchema.password
Path Parameters
id1 / 1
#validinvalidschema
1145{
2145 "type": "integer"
3145}
Responses
codedescriptionhitsavg
200This response has no body.97ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.21ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request51ms
Path Parameters
id1 / 1
#validinvalidschema
1653157{
2653157 "type": "integer"
3653157}
Responses
codedescriptionhitsavg
200userSchema5791ms
400The request data does not match what we expect.1551ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
404The requested resource was not found.631ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error101ms
Path Parameters
id1 / 1
#validinvalidschema
183417{
283417 "type": "integer"
383417}
Body
application/json9 / 9
updateUserSchema
1711104{
220978 "properties": {
318646 "email": {
418646 "type": "string"
518646 },
615050 "name": {
715050 "type": "string"
815050 },
916034 "rootRole": {
1016034 "oneOf": [
1111975 {
1212013 "minimum": 0,
1313262 "type": "integer"
1411975 },
1541153 {
1641153 "enum": [
1714n/a "Admin",
184n/a "Editor",
194n/a "Viewer",
208n/a "Owner",
216n/a "Member",
225n/a "Reader"
2341153 ],
2449145 "type": "string"
2541153 }
2616034 ]
2716034 }
2820978 },
2978926 "type": "object"
30711104}
Responses
codedescriptionhitsavg
200createUserResponseSchema5454ms
400The request data does not match what we expect.1681ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
404The requested resource was not found.751ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error573ms
41531ms
Examples
Body: application/json
"user@example.com"updateUserSchema.email
"Sam Seawright"updateUserSchema.name
1updateUserSchema.rootRole
"Admin"updateUserSchema.rootRole
Path Parameters
id1 / 1
#validinvalidschema
180730{
280730 "type": "integer"
380730}
Body
application/json6 / 6
passwordSchema
1564106{
2n/a0 "additionalProperties": false,
359461 "properties": {
414045 "confirmPassword": {
514045 "type": "string"
614045 },
713133 "oldPassword": {
813133 "type": "string"
913133 },
1059728 "password": {
1159728 "type": "string"
1259728 }
1359461 },
1462540 "required": [
1562540 "password"
1662540 ],
176655 "type": "object"
18564106}
Responses
codedescriptionhitsavg
200This response has no body.156ms
400The request data does not match what we expect.1641ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.31ms
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
429Too Many Requests6691ms
Examples
Body: application/json
"k!5As3HquUrQ"passwordSchema.confirmPassword
"Oldk!5As3HquUrQ"passwordSchema.oldPassword
"k!5As3HquUrQ"passwordSchema.password
Body
application/json6 / 6
passwordSchema
#validinvalidschema
1163220{
2n/a0 "additionalProperties": false,
3197130 "properties": {
413775 "confirmPassword": {
513775 "type": "string"
613775 },
711890 "oldPassword": {
811890 "type": "string"
911890 },
10190103 "password": {
11190103 "type": "string"
12190103 }
13197130 },
1429369 "required": [
1529369 "password"
1629369 ],
1736221 "type": "object"
18163220}
Responses
codedescriptionhitsavg
200This response has no body.0never seen
400Old and new password do not match8210ms
401Old password is incorrect or user is not authenticated0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error52ms
41531ms
Examples
Body: application/json
"k!5As3HquUrQ"passwordSchema.confirmPassword
"Oldk!5As3HquUrQ"passwordSchema.oldPassword
"k!5As3HquUrQ"passwordSchema.password
Responses
codedescriptionhitsavg
200profileSchema0never seen
400The request data does not match what we expect.18201ms
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
Query Parameters
projectId1 / 1
#validinvalidschema
1734n/a{
2734n/a "type": "string"
3734n/a}
Responses
codedescriptionhitsavg
200rolesSchema0never seen
401Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.0never seen
403The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error7191ms
400Bad Request841ms
744 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
DELETE0.0.0.0:37503/api/admin/addonsmethod not documented1
DELETE0.0.0.0:37503/api/admin/addons/{id}/eventsmethod not documented1
DELETE0.0.0.0:37503/api/admin/api-tokensmethod not documented1
DELETE0.0.0.0:37503/api/admin/archive/revive/{featureName}method not documented1
DELETE0.0.0.0:37503/api/admin/client-metrics/features/{name}method not documented1
DELETE0.0.0.0:37503/api/admin/client-metrics/features/{name}/rawmethod not documented1
DELETE0.0.0.0:37503/api/admin/constraints/validatemethod not documented1
DELETE0.0.0.0:37503/api/admin/contextmethod not documented1
DELETE0.0.0.0:37503/api/admin/context/{contextField}/legal-valuesmethod not documented1
DELETE0.0.0.0:37503/api/admin/context/{contextField}/strategiesmethod not documented1

... and 734 more groups