Schemathesis 4.30.1
API Coverage Report
2026-10-10 20:01:35
Operations
Operations called at least once
99.2% 277 of 279 called
Parameters
Tested with valid and invalid values
98.0% 446 of 455 covered
Keywords
Constraints tested both ways
97.5% 4124 of 4227 covered
Examples
Schema examples sent in tests
97.9% 146 of 149 used
Responses
Documented response codes hit
67.6% 190 of 281 received
Show
Activities 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
albumId3 / 3
#validinvalidschema
11329130{
21329130 "format": "uuid",
31329130 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
41459n/a "type": "string"
51329130}
assetId3 / 3
126988{
226988 "format": "uuid",
326988 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4357n/a "type": "string"
526988}
type2 / 2
ReactionType
134977{
234977 "enum": [
3171n/a "comment",
4178n/a "like"
534977 ],
6426n/a "type": "string"
734977}
level2 / 2
ReactionLevel
137435{
237435 "enum": [
3218n/a "album",
4156n/a "asset"
537435 ],
6409n/a "type": "string"
737435}
userId3 / 3
1117434{
2117434 "format": "uuid",
3117434 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
41208n/a "type": "string"
5117434}
Responses
codedescriptionhitsavg
20010342ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized741ms
400Bad Request3602ms
Body
application/json13 / 13
ActivityCreateDto
#validinvalidschema
11108112{
2112388 "properties": {
3115743 "albumId": {
4115720 "format": "uuid",
5115720 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
6117723 "type": "string"
7115743 },
835335 "assetId": {
935318 "format": "uuid",
1035318 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
1137117 "type": "string"
1235335 },
1348430 "comment": {
1448430 "type": "string"
1548430 },
16118224 "type": {
18118224 }
19112388 },
20119617 "required": [
21120013 "albumId",
2212067 "type"
23119617 ],
2412137 "type": "object"
251108112}
Referenced Components (1)3 of 3 keywords
ReactionType3 of 3 keywords
1118224{
2118224 "enum": [
3559n/a "comment",
4623n/a "like"
5118224 ],
612015 "type": "string"
7118224}
Responses
codedescriptionhitsavg
20156ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request15252ms
401Unauthorized601ms
500Internal Server Error143ms
Query Parameters
albumId3 / 3
#validinvalidschema
156161{
256161 "format": "uuid",
356161 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4622n/a "type": "string"
556161}
assetId3 / 3
17359{
27359 "format": "uuid",
37359 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4132n/a "type": "string"
57359}
Responses
codedescriptionhitsavg
2004512ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized541ms
400Bad Request1222ms
Path Parameters
id3 / 3
#validinvalidschema
119939{
219939 "format": "uuid",
319939 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4238n/a "type": "string"
519939}
Responses
codedescriptionhitsavg
20448ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2102ms
401Unauthorized241ms
Albums 13 operations 13 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
id3 / 3
#validinvalidschema
1205790{
2205790 "format": "uuid",
3205790 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
42147n/a "type": "string"
5205790}
name1 / 1
1699n/a{
2699n/a "type": "string"
3699n/a}
isOwned1 / 1
1674154{
2674154 "type": "boolean"
3674154}
isShared1 / 1
168245{
268245 "type": "boolean"
368245}
assetId3 / 3
1476114{
2476114 "format": "uuid",
3476114 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4590n/a "type": "string"
5476114}
Responses
codedescriptionhitsavg
20020494ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1941ms
400Bad Request2552ms
Body
application/json21 / 21
CreateAlbumDto
#validinvalidschema
11982233{
21992170 "properties": {
3213616 "albumName": {
4213616 "type": "string"
5213616 },
6345125 "albumUsers": {
7345110 "items": {
9345110 },
1045515 "type": "array"
11345125 },
1226567 "assetIds": {
1326532 "items": {
1412374 "format": "uuid",
1512374 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
1619720 "type": "string"
1726532 },
1829735 "type": "array"
1926567 },
2048340 "description": {
21523n/a "nullable": true,
2248340 "type": "string",
2348340 }
241992170 },
25215253 "required": [
26215253 "albumName"
27215253 ],
28220510 "type": "object"
291982233}
Referenced Components (2)12 of 12 keywords
AlbumUserCreateDto9 of 9 keywords
1197420{
2206381 "properties": {
350876 "role": {
550876 },
6206375 "userId": {
7206301 "format": "uuid",
8206301 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
950774 "type": "string"
10206375 }
11206381 },
1257828 "required": [
1358125 "userId",
1458422 "role"
1557828 ],
1660611 "type": "object"
17197420}
AlbumUserRole3 of 3 keywords
150876{
250876 "enum": [
3127n/a "editor",
4257n/a "owner",
5124n/a "viewer"
650876 ],
75795 "type": "string"
850876}
Responses
codedescriptionhitsavg
20117806ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1111ms
400Bad Request4112ms
500Internal Server Error123ms
Body
application/json11 / 11
AlbumsAddAssetsDto
#validinvalidschema
1278187{
2284160 "properties": {
3290149 "albumIds": {
429012 "items": {
5106137 "format": "uuid",
6106137 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
72435 "type": "string"
829012 },
9302137 "type": "array"
10290149 },
11302141 "assetIds": {
12302123 "items": {
13213342 "format": "uuid",
14213342 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
15555195 "type": "string"
16302123 },
1742518 "type": "array"
18302141 }
19284160 },
2043816 "required": [
2143915 "albumIds",
2244311 "assetIds"
2343816 ],
2445411 "type": "object"
25278187}
Responses
codedescriptionhitsavg
2001752ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1031ms
400Bad Request2571ms
Responses
codedescriptionhitsavg
2001917ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3181ms
Path Parameters
id3 / 3
#validinvalidschema
11336{
21336 "format": "uuid",
31336 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4139n/a "type": "string"
51336}
Responses
codedescriptionhitsavg
2041015ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized131ms
400Bad Request252ms
Path Parameters
id3 / 3
#validinvalidschema
158514{
258514 "format": "uuid",
358514 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4599n/a "type": "string"
558514}
Query Parameters
key1 / 1
1163n/a{
2163n/a "type": "string"
3163n/a}
slug1 / 1
1131n/a{
2131n/a "type": "string"
3131n/a}
Responses
codedescriptionhitsavg
2003484ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1871ms
400Bad Request642ms
Path Parameters
id3 / 3
#validinvalidschema
162315{
262315 "format": "uuid",
362315 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4638n/a "type": "string"
562315}
Body
application/json12 / 12
UpdateAlbumDto
150497{
215990 "properties": {
31955 "albumName": {
41955 "type": "string"
51955 },
68464 "albumThumbnailAssetId": {
7845 "format": "uuid",
8845 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
98959 "type": "string"
108464 },
111209 "description": {
12129n/a "nullable": true,
131209 "type": "string",
141209 },
151226 "isActivityEnabled": {
161226 "type": "boolean"
171226 },
1812711 "order": {
2012711 }
2115990 },
225947 "type": "object"
2350497}
Referenced Components (1)3 of 3 keywords
AssetOrder3 of 3 keywords
112711{
212711 "enum": [
383n/a "asc",
444n/a "desc"
512711 ],
61335 "type": "string"
712711}
Responses
codedescriptionhitsavg
2003766ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2302ms
401Unauthorized321ms
Path Parameters
id3 / 3
#validinvalidschema
115730{
215730 "format": "uuid",
315730 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4187n/a "type": "string"
515730}
Body
application/json7 / 7
BulkIdsDto
111625{
211615 "properties": {
311615 "ids": {
411610 "items": {
511626 "format": "uuid",
611626 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
714212 "type": "string"
811610 },
91265 "type": "array"
1011615 }
1111615 },
121315 "required": [
131315 "ids"
141315 ],
151365 "type": "object"
1611625}
Responses
codedescriptionhitsavg
200603ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized281ms
400Bad Request991ms
Path Parameters
id3 / 3
#validinvalidschema
147930{
247930 "format": "uuid",
347930 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4509n/a "type": "string"
547930}
Body
application/json7 / 7
BulkIdsDto
142237{
242224 "properties": {
342224 "ids": {
442214 "items": {
547938 "format": "uuid",
647938 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
751718 "type": "string"
842214 },
943610 "type": "array"
1042224 }
1142224 },
124464 "required": [
134464 "ids"
144464 ],
154509 "type": "object"
1642237}
Responses
codedescriptionhitsavg
2003333ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized211ms
400Bad Request1551ms
Path Parameters
id3 / 3
#validinvalidschema
158719{
258719 "format": "uuid",
358719 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4606n/a "type": "string"
558719}
Query Parameters
key1 / 1
1161n/a{
2161n/a "type": "string"
3161n/a}
slug1 / 1
1148n/a{
2148n/a "type": "string"
3148n/a}
Responses
codedescriptionhitsavg
2003833ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1701ms
400Bad Request512ms
500Internal Server Error22ms
Path Parameters
id3 / 3
#validinvalidschema
164273{
264273 "format": "uuid",
364273 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4715n/a "type": "string"
564273}
userId1 / 1
1715n/a{
2715n/a "type": "string"
3715n/a}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6542ms
401Unauthorized611ms
Path Parameters
id3 / 3
#validinvalidschema
169953{
269953 "format": "uuid",
369953 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4752n/a "type": "string"
569953}
userId1 / 1
1752n/a{
2752n/a "type": "string"
3752n/a}
Body
application/json6 / 6
UpdateAlbumUserDto
166249{
266226 "properties": {
366226 "role": {
566226 }
666226 },
768816 "required": [
868816 "role"
968816 ],
107047 "type": "object"
1166249}
Referenced Components (1)3 of 3 keywords
AlbumUserRole3 of 3 keywords
166226{
266226 "enum": [
3140n/a "editor",
4425n/a "owner",
597n/a "viewer"
666226 ],
76835 "type": "string"
866226}
Responses
codedescriptionhitsavg
2045523ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized201ms
400Bad Request1802ms
Path Parameters
id3 / 3
#validinvalidschema
147460{
247460 "format": "uuid",
347460 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4534n/a "type": "string"
547460}
Body
application/json15 / 15
AddUsersDto
1173104{
217389 "properties": {
317389 "albumUsers": {
417470 "items": {
617470 },
72431 "minItems": 1,
824418 "type": "array"
917389 }
1017389 },
112625 "required": [
122625 "albumUsers"
132625 ],
1426710 "type": "object"
15173104}
Referenced Components (2)12 of 12 keywords
AlbumUserAddDto9 of 9 keywords
1221252{
2283134 "properties": {
319037 "role": {
5 "default": "editor",
619037 },
7227128 "userId": {
822758 "format": "uuid",
922758 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
1028570 "type": "string"
11227128 }
12283134 },
13355102 "required": [
14355102 "userId"
15355102 ],
1645716 "type": "object"
17221252}
AlbumUserRole3 of 3 keywords
119037{
219037 "enum": [
369n/a "editor",
494n/a "owner",
527n/a "viewer"
619037 ],
72225 "type": "string"
819037}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5201ms
401Unauthorized141ms
API keys 7 operations 7 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
20032319ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5111ms
Body
application/json9 / 9
ApiKeyCreateDto
#validinvalidschema
13975185{
23990131 "properties": {
3199749 "name": {
4199749 "type": "string"
5199749 },
63985121 "permissions": {
7398685 "items": {
9398685 },
1040701 "minItems": 1,
11407135 "type": "array"
123985121 }
133990131 },
14410639 "required": [
15410639 "permissions"
16410639 ],
17414515 "type": "object"
183975185}
Referenced Components (1)3 of 3 keywords
Permission3 of 3 keywords
121233185{
221233185 "enum": [
3520n/a "all",
4141n/a "activity.create",
5150n/a "activity.read",
6129n/a "activity.update",
7116n/a "activity.delete",
8110n/a "activity.statistics",
9139n/a "apiKey.create",
1089n/a "apiKey.read",
11122n/a "apiKey.update",
12126n/a "apiKey.delete",
13114n/a "apiKey.rotate",
14125n/a "asset.read",
1599n/a "asset.update",
16152n/a "asset.delete",
17118n/a "asset.statistics",
18139n/a "asset.share",
19137n/a "asset.view",
2097n/a "asset.download",
2188n/a "asset.upload",
22126n/a "asset.copy",
23127n/a "asset.derive",
24129n/a "assetFile.read",
25133n/a "assetFile.delete",
26163n/a "assetFile.download",
27150n/a "asset.edit.get",
28126n/a "asset.edit.create",
29168n/a "asset.edit.delete",
30137n/a "album.create",
31118n/a "album.read",
32104n/a "album.update",
33116n/a "album.delete",
3486n/a "album.statistics",
35117n/a "album.share",
36108n/a "album.download",
37118n/a "albumAsset.create",
38131n/a "albumAsset.delete",
3986n/a "albumUser.create",
40150n/a "albumUser.update",
41144n/a "albumUser.delete",
42115n/a "auth.changePassword",
43158n/a "authDevice.delete",
44124n/a "archive.read",
45123n/a "backup.list",
4691n/a "backup.download",
47126n/a "backup.upload",
4897n/a "backup.delete",
49130n/a "clusterGroup.read",
50146n/a "clusterGroup.leave",
51104n/a "clusterGroupRequest.create",
52155n/a "clusterGroupRequest.read",
5388n/a "clusterGroupRequest.delete",
54134n/a "adminConfig.read",
5590n/a "adminConfig.update",
56168n/a "userConfig.read",
57104n/a "duplicate.read",
58130n/a "duplicate.delete",
59101n/a "face.create",
60118n/a "face.read",
61131n/a "face.update",
62125n/a "face.delete",
63156n/a "folder.read",
64122n/a "job.create",
65122n/a "job.read",
66144n/a "library.create",
67142n/a "library.read",
6897n/a "library.update",
69101n/a "library.delete",
70119n/a "library.statistics",
71105n/a "timeline.read",
72121n/a "timeline.download",
73113n/a "maintenance",
74111n/a "map.read",
75108n/a "map.search",
76115n/a "memory.create",
77124n/a "memory.read",
78128n/a "memory.update",
79119n/a "memory.delete",
80129n/a "memory.statistics",
81106n/a "memoryAsset.create",
82104n/a "memoryAsset.delete",
83115n/a "notification.create",
84127n/a "notification.read",
85119n/a "notification.update",
86116n/a "notification.delete",
87142n/a "partner.create",
88101n/a "partner.read",
89107n/a "partner.update",
90120n/a "partner.delete",
91131n/a "person.create",
92183n/a "person.read",
93107n/a "person.update",
94109n/a "person.delete",
95111n/a "person.statistics",
96165n/a "person.merge",
97158n/a "person.reassign",
98152n/a "pinCode.create",
99150n/a "pinCode.update",
100142n/a "pinCode.delete",
101108n/a "plugin.create",
102105n/a "plugin.read",
103102n/a "plugin.update",
104151n/a "plugin.delete",
105131n/a "server.about",
106125n/a "server.apkLinks",
107140n/a "server.storage",
108127n/a "server.statistics",
109114n/a "server.versionCheck",
110124n/a "serverLicense.read",
111118n/a "serverLicense.update",
112126n/a "serverLicense.delete",
113104n/a "session.create",
114125n/a "session.read",
115115n/a "session.update",
116134n/a "session.delete",
117154n/a "session.lock",
118113n/a "sharedLink.create",
119154n/a "sharedLink.read",
120120n/a "sharedLink.update",
121126n/a "sharedLink.delete",
122136n/a "stack.create",
12378n/a "stack.read",
124134n/a "stack.update",
125135n/a "stack.delete",
126109n/a "sync.stream",
127136n/a "syncCheckpoint.read",
128111n/a "syncCheckpoint.update",
129125n/a "syncCheckpoint.delete",
130111n/a "systemConfig.read",
131132n/a "systemConfig.update",
132174n/a "systemMetadata.read",
133122n/a "systemMetadata.update",
13493n/a "tag.create",
135146n/a "tag.read",
136160n/a "tag.update",
137130n/a "tag.delete",
138125n/a "tag.asset",
139133n/a "user.read",
140120n/a "user.update",
141138n/a "userLicense.create",
142112n/a "userLicense.read",
14399n/a "userLicense.update",
14490n/a "userLicense.delete",
145131n/a "userOnboarding.read",
146139n/a "userOnboarding.update",
147136n/a "userOnboarding.delete",
14896n/a "userPreference.read",
149124n/a "userPreference.update",
150140n/a "userProfileImage.create",
151124n/a "userProfileImage.read",
152115n/a "userProfileImage.update",
15399n/a "userProfileImage.delete",
154112n/a "queue.read",
155142n/a "queue.update",
156103n/a "queueJob.create",
157128n/a "queueJob.read",
158103n/a "queueJob.update",
159118n/a "queueJob.delete",
160135n/a "workflow.create",
161121n/a "workflow.read",
162125n/a "workflow.update",
163162n/a "workflow.delete",
164129n/a "workflow.logs",
165108n/a "adminUser.create",
166135n/a "adminUser.read",
167109n/a "adminUser.update",
168140n/a "adminUser.delete",
169108n/a "adminSession.read",
170139n/a "adminAuth.unlinkAll"
17121233185 ],
172214135 "type": "string"
17321233185}
Responses
codedescriptionhitsavg
20138184ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1401ms
400Bad Request2801ms
500Internal Server Error172ms
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden33861ms
401Unauthorized6071ms
Path Parameters
id3 / 3
#validinvalidschema
139511{
239511 "format": "uuid",
339511 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4406n/a "type": "string"
539511}
Responses
codedescriptionhitsavg
2042844ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized851ms
400Bad Request372ms
Path Parameters
id3 / 3
#validinvalidschema
182539{
282539 "format": "uuid",
382539 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4864n/a "type": "string"
582539}
Responses
codedescriptionhitsavg
2007082ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized781ms
400Bad Request782ms
Path Parameters
id3 / 3
#validinvalidschema
1103433{
2103433 "format": "uuid",
3103433 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
41067n/a "type": "string"
5103433}
Body
application/json8 / 8
ApiKeyUpdateDto
195467{
268951 "properties": {
360919 "name": {
460919 "type": "string"
560919 },
650746 "permissions": {
750829 "items": {
950829 },
105361 "minItems": 1,
1153716 "type": "array"
1250746 }
1368951 },
14100516 "type": "object"
1595467}
Referenced Components (1)3 of 3 keywords
Permission3 of 3 keywords
1182273{
2182273 "enum": [
356n/a "all",
411n/a "activity.create",
55n/a "activity.read",
67n/a "activity.update",
76n/a "activity.delete",
814n/a "activity.statistics",
96n/a "apiKey.create",
105n/a "apiKey.read",
119n/a "apiKey.update",
129n/a "apiKey.delete",
138n/a "apiKey.rotate",
143n/a "asset.read",
154n/a "asset.update",
169n/a "asset.delete",
174n/a "asset.statistics",
189n/a "asset.share",
1910n/a "asset.view",
207n/a "asset.download",
216n/a "asset.upload",
229n/a "asset.copy",
235n/a "asset.derive",
2413n/a "assetFile.read",
256n/a "assetFile.delete",
2611n/a "assetFile.download",
274n/a "asset.edit.get",
289n/a "asset.edit.create",
294n/a "asset.edit.delete",
306n/a "album.create",
3111n/a "album.read",
324n/a "album.update",
3315n/a "album.delete",
3412n/a "album.statistics",
3523n/a "album.share",
3636n/a "album.download",
374n/a "albumAsset.create",
3813n/a "albumAsset.delete",
395n/a "albumUser.create",
404n/a "albumUser.update",
418n/a "albumUser.delete",
428n/a "auth.changePassword",
4312n/a "authDevice.delete",
445n/a "archive.read",
453n/a "backup.list",
4615n/a "backup.download",
475n/a "backup.upload",
483n/a "backup.delete",
4919n/a "clusterGroup.read",
507n/a "clusterGroup.leave",
518n/a "clusterGroupRequest.create",
524n/a "clusterGroupRequest.read",
536n/a "clusterGroupRequest.delete",
5427n/a "adminConfig.read",
5521n/a "adminConfig.update",
5614n/a "userConfig.read",
5755n/a "duplicate.read",
5823n/a "duplicate.delete",
598n/a "face.create",
607n/a "face.read",
6114n/a "face.update",
6213n/a "face.delete",
635n/a "folder.read",
6412n/a "job.create",
6511n/a "job.read",
6613n/a "library.create",
675n/a "library.read",
686n/a "library.update",
6968n/a "library.delete",
7023n/a "library.statistics",
718n/a "timeline.read",
724n/a "timeline.download",
7310n/a "maintenance",
747n/a "map.read",
7516n/a "map.search",
7611n/a "memory.create",
7712n/a "memory.read",
789n/a "memory.update",
792n/a "memory.delete",
804n/a "memory.statistics",
8111n/a "memoryAsset.create",
823n/a "memoryAsset.delete",
8316n/a "notification.create",
8420n/a "notification.read",
8515n/a "notification.update",
865n/a "notification.delete",
8714n/a "partner.create",
8812n/a "partner.read",
8912n/a "partner.update",
907n/a "partner.delete",
913n/a "person.create",
9215n/a "person.read",
9314n/a "person.update",
9410n/a "person.delete",
956n/a "person.statistics",
9611n/a "person.merge",
9710n/a "person.reassign",
984n/a "pinCode.create",
9911n/a "pinCode.update",
10013n/a "pinCode.delete",
1019n/a "plugin.create",
10210n/a "plugin.read",
1036n/a "plugin.update",
1043n/a "plugin.delete",
1057n/a "server.about",
10624n/a "server.apkLinks",
1077n/a "server.storage",
10812n/a "server.statistics",
10918n/a "server.versionCheck",
11014n/a "serverLicense.read",
1115n/a "serverLicense.update",
1128n/a "serverLicense.delete",
11312n/a "session.create",
11411n/a "session.read",
11520n/a "session.update",
11611n/a "session.delete",
11713n/a "session.lock",
11811n/a "sharedLink.create",
1198n/a "sharedLink.read",
12010n/a "sharedLink.update",
1218n/a "sharedLink.delete",
1227n/a "stack.create",
1235n/a "stack.read",
12414n/a "stack.update",
12512n/a "stack.delete",
1266n/a "sync.stream",
12716n/a "syncCheckpoint.read",
1283n/a "syncCheckpoint.update",
1297n/a "syncCheckpoint.delete",
13058n/a "systemConfig.read",
13114n/a "systemConfig.update",
1325n/a "systemMetadata.read",
1333n/a "systemMetadata.update",
1344n/a "tag.create",
13520n/a "tag.read",
1368n/a "tag.update",
1377n/a "tag.delete",
1389n/a "tag.asset",
1398n/a "user.read",
1405n/a "user.update",
14113n/a "userLicense.create",
14212n/a "userLicense.read",
1436n/a "userLicense.update",
1449n/a "userLicense.delete",
1456n/a "userOnboarding.read",
1467n/a "userOnboarding.update",
14710n/a "userOnboarding.delete",
1483n/a "userPreference.read",
14957n/a "userPreference.update",
1505n/a "userProfileImage.create",
15113n/a "userProfileImage.read",
1526n/a "userProfileImage.update",
1537n/a "userProfileImage.delete",
1545n/a "queue.read",
1553n/a "queue.update",
1562n/a "queueJob.create",
15712n/a "queueJob.read",
1588n/a "queueJob.update",
1595n/a "queueJob.delete",
16013n/a "workflow.create",
16110n/a "workflow.read",
1627n/a "workflow.update",
1635n/a "workflow.delete",
1644n/a "workflow.logs",
1658n/a "adminUser.create",
16612n/a "adminUser.read",
1675n/a "adminUser.update",
16811n/a "adminUser.delete",
1696n/a "adminSession.read",
1709n/a "adminAuth.unlinkAll"
171182273 ],
17218905 "type": "string"
173182273}
Responses
codedescriptionhitsavg
2006424ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized361ms
400Bad Request1891ms
500Internal Server Error2002ms
Path Parameters
id3 / 3
#validinvalidschema
1199177{
2199177 "format": "uuid",
3199177 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
42068n/a "type": "string"
5199177}
Responses
codedescriptionhitsavg
20115875ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1471ms
400Bad Request3342ms
Asset files 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
assetId3 / 3
#validinvalidschema
11741148{
21741148 "format": "uuid",
31741148 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
41889n/a "type": "string"
51741148}
type2 / 2
AssetFileType
175371{
275371 "enum": [
3156n/a "fullsize",
4152n/a "preview",
5122n/a "thumbnail",
6185n/a "sidecar",
7138n/a "encoded_video"
875371 ],
9824n/a "type": "string"
1075371}
isEdited1 / 1
174468{
274468 "type": "boolean"
374468}
isProgressive1 / 1
174650{
274650 "type": "boolean"
374650}
isTransparent1 / 1
179345{
279345 "type": "boolean"
379345}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request18583ms
401Unauthorized641ms
Path Parameters
id3 / 3
#validinvalidschema
1383128{
2383128 "format": "uuid",
3383128 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5383128}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4732ms
401Unauthorized381ms
Path Parameters
id3 / 3
#validinvalidschema
1401110{
2401110 "format": "uuid",
3401110 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5401110}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4652ms
401Unauthorized461ms
Path Parameters
id3 / 3
#validinvalidschema
1403108{
2403108 "format": "uuid",
3403108 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5403108}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3722ms
400Bad Request1081ms
401Unauthorized311ms
Assets 26 operations 25 covered 1 partial 0 uncovered 0 not measured 97% #
Body
application/json8 / 8
AssetBulkDeleteDto
#validinvalidschema
141090{
241573 "properties": {
319313 "force": {
419313 "type": "boolean"
519313 },
641964 "ids": {
741913 "items": {
845210 "format": "uuid",
945210 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
1046226 "type": "string"
1141913 },
1243251 "type": "array"
1341964 }
1441573 },
1548311 "required": [
1648311 "ids"
1748311 ],
184946 "type": "object"
1941090}
Responses
codedescriptionhitsavg
2041091ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized831ms
400Bad Request3462ms
Query Parameters
key1 / 1
#validinvalidschema
1335n/a{
2335n/a "type": "string"
3335n/a}
slug1 / 1
1318n/a{
2318n/a "type": "string"
3318n/a}
Headers
x-immich-checksum1 / 1
1329n/a{
2329n/a "type": "string"
3329n/a}
Body
multipart/form-data24 / 32
AssetMediaCreateDto
1209285{
2216278 "properties": {
3245n/a "assetData": {
4245n/a "format": "binary",
5245n/a "type": "string",
6245n/a },
720824 "duration": {
82113 "maximum": 9007199254740991,
92113 "minimum": 0,
1021418 "type": "integer"
1120824 },
12373115 "fileCreatedAt": {
13373115 "format": "date-time",
14376112 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
15488n/a "type": "string"
16373115 },
1746724 "fileModifiedAt": {
1846724 "format": "date-time",
1947021 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
20491n/a "type": "string"
2146724 },
22231n/a "filename": {
23231n/a "type": "string"
24231n/a },
2522215 "isFavorite": {
2622215 "type": "boolean"
2722215 },
282133 "livePhotoVideoId": {
292133 "format": "uuid",
302133 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
31216n/a "type": "string"
322133 },
330106 "metadata": {
340106 "items": {
360106 },
371060 "type": "array"
380106 },
39205n/a "sidecarData": {
40205n/a "format": "binary",
41205n/a "type": "string"
42205n/a },
4321110 "visibility": {
4521110 }
46216278 },
474859 "required": [
484886 "fileCreatedAt",
494913 "fileModifiedAt"
504859 ],
51494n/a "type": "object"
52209285}
Referenced Components (2)3 of 11 keywords
AssetMetadataUpsertItemDto0 of 8 keywords
10331{
200 "properties": {
300 "key": {
400 "type": "string"
500 },
600 "value": {
70n/a "additionalProperties": {},
800 "type": "object"
900 }
1000 },
1100 "required": [
1200 "key",
1300 "value"
1400 ],
150331 "type": "object"
160331}
AssetVisibility3 of 3 keywords
121110{
221110 "enum": [
3151n/a "archive",
416n/a "timeline",
522n/a "hidden",
622n/a "locked"
721110 ],
8221n/a "type": "string"
921110}
Responses
codedescriptionhitsavg
200Asset is a duplicate0never seen
201Asset uploaded successfully0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5662ms
401Unauthorized1391ms
Examples
Body: multipart/form-data
"2024-01-01T00:00:00.000Z"AssetMediaCreateDto.fileCreatedAt
"2024-01-01T00:00:00.000Z"AssetMediaCreateDto.fileModifiedAt
Body
application/json31 / 31
AssetBulkUpdateDto
#validinvalidschema
1388168{
245588 "properties": {
33135 "dateTimeOriginal": {
43135 "type": "string"
53135 },
625316 "dateTimeRelative": {
72586 "maximum": 9007199254740991,
82604 "minimum": -9007199254740991,
92636 "type": "integer"
1025316 },
1126311 "description": {
1226311 "type": "string"
1326311 },
142614 "duplicateId": {
15265n/a "nullable": true,
162614 "type": "string"
172614 },
1845521 "ids": {
1945511 "items": {
2017941 "format": "uuid",
2117941 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
222205 "type": "string"
2345511 },
2446610 "type": "array"
2545521 },
262585 "isFavorite": {
272585 "type": "boolean"
282585 },
2924714 "latitude": {
302565 "format": "double",
312542 "maximum": 90,
322497 "minimum": -90,
332565 "type": "number"
3424714 },
352527 "longitude": {
362545 "format": "double",
372531 "maximum": 180,
382531 "minimum": -180,
392545 "type": "number"
402527 },
412698 "rating": {
422121 "maximum": 5,
432121 "minimum": -1,
44277n/a "nullable": true,
452716 "type": "integer",
462698 },
472525 "timeZone": {
482525 "type": "string"
492525 },
502466 "visibility": {
522466 }
5345588 },
5447673 "required": [
5547673 "ids"
5647673 ],
575497 "type": "object"
58388168}
Referenced Components (1)3 of 3 keywords
AssetVisibility3 of 3 keywords
12466{
22466 "enum": [
3112n/a "archive",
424n/a "timeline",
581n/a "hidden",
629n/a "locked"
72466 ],
82475 "type": "string"
92466}
Responses
codedescriptionhitsavg
2041892ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3631ms
401Unauthorized611ms
500Internal Server Error152ms
Body
application/json10 / 10
AssetBulkUploadCheckDto
#validinvalidschema
148162{
248150 "properties": {
348150 "assets": {
448138 "items": {
648138 },
751912 "type": "array"
848150 }
948150 },
105315 "required": [
115315 "assets"
125315 ],
135367 "type": "object"
1448162}
Referenced Components (1)7 of 7 keywords
AssetBulkUploadCheckItem7 of 7 keywords
1166972{
2168442 "properties": {
3168837 "checksum": {
4168837 "type": "string"
5168837 },
6167537 "id": {
7167537 "type": "string"
8167537 }
9168442 },
10171118 "required": [
11171217 "id",
1217254 "checksum"
13171118 ],
14172912 "type": "object"
15166972}
Responses
codedescriptionhitsavg
2002342ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error792ms
400Bad Request891ms
401Unauthorized1681ms
Body
application/json14 / 14
AssetCopyDto
#validinvalidschema
1116111{
212696 "properties": {
313513 "albums": {
413513 "type": "boolean"
513513 },
613411 "favorite": {
713411 "type": "boolean"
813411 },
913214 "sharedLinks": {
1013214 "type": "boolean"
1113214 },
1211620 "sidecar": {
1311620 "type": "boolean"
1411620 },
1517637 "sourceId": {
1617625 "format": "uuid",
1717625 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
1820112 "type": "string"
1917637 },
2011915 "stack": {
2111915 "type": "boolean"
2211915 },
2317148 "targetId": {
2417141 "format": "uuid",
2517141 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
262127 "type": "string"
2717148 }
2812696 },
2921210 "required": [
302139 "sourceId",
312193 "targetId"
3221210 ],
332225 "type": "object"
34116111}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5381ms
401Unauthorized221ms
Examples
Body: application/json
trueAssetCopyDto.albums
trueAssetCopyDto.favorite
trueAssetCopyDto.sharedLinks
trueAssetCopyDto.sidecar
trueAssetCopyDto.stack
Body
application/json10 / 10
AssetJobsDto
#validinvalidschema
142662{
243538 "properties": {
343926 "assetIds": {
443913 "items": {
521423 "format": "uuid",
621423 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
72375 "type": "string"
843913 },
945213 "type": "array"
1043926 },
1144626 "name": {
1344626 }
1443538 },
154649 "required": [
164658 "assetIds",
174721 "name"
184649 ],
1947315 "type": "object"
2042662}
Referenced Components (1)3 of 3 keywords
AssetJobName3 of 3 keywords
144626{
244626 "enum": [
3332n/a "refresh-faces",
424n/a "refresh-metadata",
539n/a "regenerate-thumbnail",
651n/a "transcode-video"
744626 ],
84675 "type": "string"
944626}
Responses
codedescriptionhitsavg
2041911ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2021ms
400Bad Request1491ms
Body
application/json12 / 12
AssetMetadataBulkDeleteDto
#validinvalidschema
1288206{
2288132 "properties": {
3288132 "items": {
4288110 "items": {
6288110 },
739822 "type": "array"
8288132 }
9288132 },
1042056 "required": [
1142056 "items"
1242056 ],
1347618 "type": "object"
14288206}
Referenced Components (1)9 of 9 keywords
AssetMetadataBulkDeleteItemDto9 of 9 keywords
1343380{
2354332 "properties": {
3351327 "assetId": {
4351172 "format": "uuid",
5351172 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
6523155 "type": "string"
7351327 },
8494189 "key": {
9494189 "type": "string"
10494189 }
11354332 },
1267511 "required": [
136788 "assetId",
146833 "key"
1567511 ],
1668637 "type": "object"
17343380}
Responses
codedescriptionhitsavg
2041271ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized781ms
400Bad Request3372ms
Body
application/json14 / 14
AssetMetadataBulkUpsertDto
#validinvalidschema
1295172{
2295133 "properties": {
3295133 "items": {
4295115 "items": {
6295115 },
741018 "type": "array"
8295133 }
9295133 },
1042827 "required": [
1142827 "items"
1242827 ],
1345512 "type": "object"
14295172}
Referenced Components (1)11 of 11 keywords
AssetMetadataBulkUpsertItemDto11 of 11 keywords
1303354{
2306325 "properties": {
3317313 "assetId": {
4317181 "format": "uuid",
5317181 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
6498132 "type": "string"
7317313 },
861119 "key": {
961119 "type": "string"
1061119 },
1160921 "value": {
12498n/a "additionalProperties": {},
1360921 "type": "object"
1460921 }
15306325 },
166285 "required": [
176303 "assetId",
186303 "key",
196303 "value"
206285 ],
2163324 "type": "object"
22303354}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1072ms
400Bad Request3242ms
401Unauthorized961ms
Query Parameters
visibility2 / 2
AssetVisibility
#validinvalidschema
1123199{
2123199 "enum": [
339n/a "archive",
425n/a "timeline",
532n/a "hidden",
627n/a "locked"
7123199 ],
8322n/a "type": "string"
9123199}
isFavorite1 / 1
1154220{
2154220 "type": "boolean"
3154220}
isTrashed1 / 1
1111253{
2111253 "type": "boolean"
3111253}
Responses
codedescriptionhitsavg
2001611ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized881ms
400Bad Request3031ms
Path Parameters
id3 / 3
#validinvalidschema
144271{
244271 "format": "uuid",
344271 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4513n/a "type": "string"
544271}
Query Parameters
key1 / 1
1115n/a{
2115n/a "type": "string"
3115n/a}
slug1 / 1
196n/a{
296n/a "type": "string"
396n/a}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3873ms
401Unauthorized1261ms
Path Parameters
id3 / 3
#validinvalidschema
157297{
257297 "format": "uuid",
357297 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4669n/a "type": "string"
557297}
Body
application/json24 / 24
UpdateAssetDto
1291140{
2188133 "properties": {
323810 "dateTimeOriginal": {
423810 "type": "string"
523810 },
62275 "description": {
72275 "type": "string"
82275 },
920316 "isFavorite": {
1020316 "type": "boolean"
1120316 },
1217454 "latitude": {
1318642 "format": "double",
141806 "maximum": 90,
151806 "minimum": -90,
1618642 "type": "number"
1717454 },
1818814 "livePhotoVideoId": {
19313 "format": "uuid",
20202n/a "nullable": true,
21313 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
2219111 "type": "string"
2318814 },
2418449 "longitude": {
2519538 "format": "double",
261923 "maximum": 180,
271878 "minimum": -180,
2819538 "type": "number"
2918449 },
3020117 "rating": {
311343 "maximum": 5,
321334 "minimum": -1,
33218n/a "nullable": true,
3420810 "type": "integer",
3520117 },
3619316 "visibility": {
3819316 }
39188133 },
404247 "type": "object"
41291140}
Referenced Components (1)3 of 3 keywords
AssetVisibility3 of 3 keywords
119316{
219316 "enum": [
3102n/a "archive",
424n/a "timeline",
540n/a "hidden",
627n/a "locked"
719316 ],
82045 "type": "string"
919316}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6561ms
401Unauthorized131ms
Path Parameters
id3 / 3
#validinvalidschema
1409102{
2409102 "format": "uuid",
3409102 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5409102}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4581ms
401Unauthorized531ms
Path Parameters
id3 / 3
#validinvalidschema
1390121{
2390121 "format": "uuid",
3390121 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5390121}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4682ms
401Unauthorized431ms
Path Parameters
id3 / 3
#validinvalidschema
1415147{
2415147 "format": "uuid",
3415147 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4562n/a "type": "string"
5415147}
Body
application/json43 / 43
AssetEditsCreateDto
1270125{
2270118 "properties": {
3270118 "edits": {
4271112 "items": {
6271112 },
73821 "minItems": 1,
83835 "type": "array"
9270118 }
10270118 },
113882 "required": [
123882 "edits"
133882 ],
143905 "type": "object"
15270125}
Referenced Components (6)48 of 48 keywords
AssetEditAction3 of 3 keywords
1115657{
2115657 "enum": [
3504n/a "crop",
4330n/a "rotate",
5322n/a "mirror"
6115657 ],
712085 "type": "string"
8115657}
AssetEditActionItemDto11 of 11 keywords
11072156{
21083140 "properties": {
3115657 "action": {
5115657 },
6113092 "parameters": {
7113092 "anyOf": [
8358864 {
10358864 },
11395827 {
13395827 },
14377845 {
16377845 }
17113092 ],
18113092 }
191083140 },
20121211 "required": [
21121310 "action",
2212221 "parameters"
23121211 ],
2412235 "type": "object"
251072156}
CropParameters17 of 17 keywords
1358864{
236262 "properties": {
338637 "height": {
43972 "maximum": 9007199254740991,
538811 "minimum": 1,
639825 "type": "integer"
738637 },
839528 "width": {
94161 "maximum": 9007199254740991,
1039621 "minimum": 1,
114167 "type": "integer"
1239528 },
134158 "x": {
144171 "maximum": 9007199254740991,
154171 "minimum": 0,
164176 "type": "integer"
174158 },
184149 "y": {
194161 "maximum": 9007199254740991,
204161 "minimum": 0,
214167 "type": "integer"
224149 }
2336262 },
24420797 "required": [
25423794 "x",
26423794 "y",
27423794 "width",
28423794 "height"
29420797 ],
3012175 "type": "object"
31358864}
MirrorAxis3 of 3 keywords
13776{
23776 "enum": [
3206n/a "horizontal",
4171n/a "vertical"
53776 ],
63785 "type": "string"
73776}
MirrorParameters6 of 6 keywords
1377845{
23776 "properties": {
33776 "axis": {
53776 }
63776 },
7383834 "required": [
8383834 "axis"
9383834 ],
1012175 "type": "object"
11377845}
RotateParameters8 of 8 keywords
1395827{
239514 "properties": {
339514 "angle": {
43971 "maximum": 270,
53971 "minimum": 0,
639712 "type": "integer"
739514 }
839514 },
9409808 "required": [
10409808 "angle"
11409808 ],
1212175 "type": "object"
13395827}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5541ms
401Unauthorized81ms
Path Parameters
id3 / 3
#validinvalidschema
1366145{
2366145 "format": "uuid",
3366145 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5366145}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4732ms
401Unauthorized381ms
Path Parameters
id3 / 3
#validinvalidschema
145099{
245099 "format": "uuid",
345099 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4549n/a "type": "string"
545099}
Body
application/json11 / 11
AssetMetadataUpsertDto
138662{
238647 "properties": {
338647 "items": {
438640 "items": {
638640 },
74267 "type": "array"
838647 }
938647 },
104337 "required": [
114337 "items"
124337 ],
134408 "type": "object"
1438662}
Referenced Components (1)8 of 8 keywords
AssetMetadataUpsertItemDto8 of 8 keywords
1555165{
261381 "properties": {
362932 "key": {
462932 "type": "string"
562932 },
659376 "value": {
7459n/a "additionalProperties": {},
859376 "type": "object"
959376 }
1061381 },
1163658 "required": [
1266133 "key",
1366925 "value"
1463658 ],
1569426 "type": "object"
16555165}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5311ms
401Unauthorized181ms
Path Parameters
id3 / 3
#validinvalidschema
1396115{
2396115 "format": "uuid",
3396115 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5396115}
key1 / 1
1511n/a{
2511n/a "type": "string"
3511n/a}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4671ms
401Unauthorized441ms
Path Parameters
id3 / 3
#validinvalidschema
1388123{
2388123 "format": "uuid",
3388123 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5388123}
key1 / 1
1511n/a{
2511n/a "type": "string"
3511n/a}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4682ms
401Unauthorized431ms
Path Parameters
id3 / 3
#validinvalidschema
1374137{
2374137 "format": "uuid",
3374137 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5374137}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4792ms
401Unauthorized321ms
Path Parameters
id3 / 3
#validinvalidschema
1418108{
2418108 "format": "uuid",
3418108 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4526n/a "type": "string"
5418108}
Query Parameters
edited1 / 1
111845{
211845 "type": "boolean"
311845}
key1 / 1
1100n/a{
2100n/a "type": "string"
3100n/a}
slug1 / 1
1100n/a{
2100n/a "type": "string"
3100n/a}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3232ms
400Bad Request881ms
401Unauthorized1151ms
Path Parameters
id3 / 3
#validinvalidschema
143695{
243695 "format": "uuid",
343695 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4531n/a "type": "string"
543695}
Query Parameters
size2 / 2
AssetMediaSize
17379{
27379 "enum": [
320n/a "original",
413n/a "fullsize",
523n/a "preview",
617n/a "thumbnail"
77379 ],
8152n/a "type": "string"
97379}
edited1 / 1
113247{
213247 "type": "boolean"
313247}
key1 / 1
1120n/a{
2120n/a "type": "string"
3120n/a}
slug1 / 1
1106n/a{
2106n/a "type": "string"
3106n/a}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found122ms
400Bad Request4202ms
401Unauthorized1101ms
500Internal Server Error11ms
Path Parameters
id3 / 3
#validinvalidschema
142984{
242984 "format": "uuid",
342984 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4513n/a "type": "string"
542984}
Query Parameters
key1 / 1
1131n/a{
2131n/a "type": "string"
3131n/a}
slug1 / 1
197n/a{
297n/a "type": "string"
397n/a}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3252ms
400Bad Request561ms
401Unauthorized1321ms
Path Parameters
id3 / 3
#validinvalidschema
143875{
243875 "format": "uuid",
343875 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4513n/a "type": "string"
543875}
Query Parameters
key1 / 1
1108n/a{
2108n/a "type": "string"
3108n/a}
slug1 / 1
180n/a{
280n/a "type": "string"
380n/a}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3972ms
401Unauthorized1121ms
500Internal Server Error41ms
Path Parameters
id3 / 3
#validinvalidschema
148373{
248373 "format": "uuid",
348373 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4556n/a "type": "string"
548373}
sessionId3 / 3
148868{
248868 "format": "uuid",
348868 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4556n/a "type": "string"
548868}
Query Parameters
key1 / 1
1134n/a{
2134n/a "type": "string"
3134n/a}
slug1 / 1
1129n/a{
2129n/a "type": "string"
3129n/a}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4092ms
401Unauthorized1451ms
500Internal Server Error21ms
Path Parameters
id3 / 3
#validinvalidschema
153150{
253150 "format": "uuid",
353150 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4581n/a "type": "string"
553150}
sessionId3 / 3
153447{
253447 "format": "uuid",
353447 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4581n/a "type": "string"
553447}
variantIndex3 / 3
152556{
254513 "maximum": 9007199254740991,
353820 "minimum": 0,
455823 "type": "integer"
552556}
Query Parameters
key1 / 1
1165n/a{
2165n/a "type": "string"
3165n/a}
slug1 / 1
1153n/a{
2153n/a "type": "string"
3153n/a}
Headers
x-immich-hls-pos2 / 2
112943{
21292 "minimum": 0,
313141 "type": "number"
412943}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4342ms
401Unauthorized1471ms
Path Parameters
id3 / 3
#validinvalidschema
157138{
257138 "format": "uuid",
357138 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4609n/a "type": "string"
557138}
sessionId3 / 3
157534{
257534 "format": "uuid",
357534 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4609n/a "type": "string"
557534}
variantIndex3 / 3
158623{
25906 "maximum": 9007199254740991,
35924 "minimum": 0,
459613 "type": "integer"
558623}
filename2 / 2
159118{
259118 "pattern": "^(init\\.mp4|seg_\\d+\\.m4s)$",
3609n/a "type": "string"
459118}
Query Parameters
key1 / 1
1208n/a{
2208n/a "type": "string"
3208n/a}
slug1 / 1
1186n/a{
2186n/a "type": "string"
3186n/a}
Headers
x-immich-hls-msn3 / 3
115041{
21522 "maximum": 9007199254740991,
31522 "minimum": 0,
415437 "type": "integer"
515041}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3703ms
400Bad Request741ms
401Unauthorized1651ms
Authentication 17 operations 16 covered 0 partial 1 uncovered 0 not measured 89% #
Body
application/json8 / 8
SignUpDto
#validinvalidschema
13607361{
23667268 "properties": {
33688217 "email": {
43742163 "format": "email",
53688163 "pattern": "^[\\p{L}\\p{M}\\p{N}.!#$%&'*+/=?^_`{|}~-]+@[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?(?:\\.[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?)*$",
6385154 "type": "string"
73688217 },
8384965 "name": {
9384965 "type": "string"
10384965 },
11383287 "password": {
12383287 "type": "string"
13383287 }
143667268 },
15387568 "required": [
16390538 "email",
17391924 "password",
18391429 "name"
19387568 ],
20394325 "type": "object"
213607361}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request44091ms
Examples
Body: application/json
"testuser@email.com"SignUpDto.email
"Admin"SignUpDto.name
"password"SignUpDto.password
Body
application/jsonno coverage data
ChangePasswordDto
#validinvalidschema
100{
200 "properties": {
300 "invalidateSessions": {
400 "type": "boolean"
500 },
600 "newPassword": {
700 "minLength": 8,
800 "type": "string"
900 },
1000 "password": {
1100 "type": "string"
1200 }
1300 },
1400 "required": [
1500 "password",
1600 "newPassword"
1700 ],
1800 "type": "object"
1900}
Expected Responses
codedescriptionhitsavg
2000never seen
Body
application/json7 / 7
LoginCredentialDto
#validinvalidschema
1266123{
228678 "properties": {
328766 "email": {
431835 "format": "email",
528735 "pattern": "^[\\p{L}\\p{M}\\p{N}.!#$%&'*+/=?^_`{|}~-]+@[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?(?:\\.[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?)*$",
632231 "type": "string"
728766 },
831045 "password": {
931045 "type": "string"
1031045 }
1128678 },
1234420 "required": [
1335311 "email",
143559 "password"
1534420 ],
1636425 "type": "object"
17266123}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized26637ms
400Bad Request3361ms
Examples
Body: application/json
"testuser@email.com"LoginCredentialDto.email
"password"LoginCredentialDto.password
Responses
codedescriptionhitsavg
2001784ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2851ms
Body
application/json5 / 5
PinCodeResetDto
#validinvalidschema
1311192{
2158160 "properties": {
3174128 "password": {
4174128 "type": "string"
5174128 },
6122155 "pinCode": {
712266 "pattern": "^\\d{6}$",
818889 "type": "string"
9122155 }
10158160 },
1147132 "type": "object"
12311192}
Responses
codedescriptionhitsavg
204149ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4988ms
401Unauthorized331ms
Examples
Body: application/json
"password"PinCodeResetDto.password
"123456"PinCodeResetDto.pinCode
Body
application/json5 / 5
PinCodeSetupDto
#validinvalidschema
131992{
231974 "properties": {
331974 "pinCode": {
431925 "pattern": "^\\d{6}$",
534449 "type": "string"
631974 }
731974 },
839311 "required": [
939311 "pinCode"
1039311 ],
114047 "type": "object"
1231992}
Responses
codedescriptionhitsavg
204340ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized441ms
400Bad Request4831ms
Examples
Body: application/json
"123456"PinCodeSetupDto.pinCode
Body
application/json8 / 8
PinCodeChangeDto
#validinvalidschema
117485{
219061 "properties": {
319738 "newPinCode": {
419715 "pattern": "^\\d{6}$",
521223 "type": "string"
619738 },
71018 "password": {
81018 "type": "string"
91018 },
108239 "pinCode": {
118214 "pattern": "^\\d{6}$",
129625 "type": "string"
138239 }
1419061 },
1523518 "required": [
1623518 "newPinCode"
1723518 ],
182536 "type": "object"
1917485}
Responses
codedescriptionhitsavg
204181ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4924ms
401Unauthorized461ms
Examples
Body: application/json
"password"PinCodeChangeDto.password
"123456"PinCodeChangeDto.pinCode
Responses
codedescriptionhitsavg
2041823ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3921ms
Body
application/json5 / 5
SessionUnlockDto
#validinvalidschema
1368135{
219363 "properties": {
313852 "password": {
413852 "type": "string"
513852 },
616457 "pinCode": {
716414 "pattern": "^\\d{6}$",
817843 "type": "string"
916457 }
1019363 },
1143172 "type": "object"
12368135}
Responses
codedescriptionhitsavg
2042939ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized751ms
400Bad Request4448ms
Examples
Body: application/json
"password"SessionUnlockDto.password
"123456"SessionUnlockDto.pinCode
Responses
codedescriptionhitsavg
2001591ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3531ms
Responses
codedescriptionhitsavg
2001901ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3961ms
Body
application/json6 / 6
OAuthConfigDto
#validinvalidschema
1211190{
227681 "properties": {
319640 "codeChallenge": {
419640 "type": "string"
519640 },
623557 "redirectUri": {
723557 "type": "string"
823557 },
913061 "state": {
1013061 "type": "string"
1113061 }
1227681 },
1329298 "required": [
1429298 "redirectUri"
1529298 ],
1639011 "type": "object"
17211190}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5481ms
500Internal Server Error203ms
Body
application/x-www-form-urlencoded4 / 4
OAuthBackchannelLogoutDto
#validinvalidschema
1217274{
2217n/a "properties": {
3217n/a "logout_token": {
4217n/a "type": "string"
5217n/a }
6217n/a },
7217274 "required": [
8217274 "logout_token"
9217274 ],
10491n/a "type": "object"
11217274}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5372ms
Body
application/json7 / 7
OAuthCallbackDto
#validinvalidschema
1183122{
219891 "properties": {
312338 "codeVerifier": {
412338 "type": "string"
512338 },
610935 "state": {
710935 "type": "string"
810935 },
920173 "url": {
1020138 "minLength": 1,
1123935 "type": "string"
1220173 }
1319891 },
1427425 "required": [
1527425 "url"
1627425 ],
172996 "type": "object"
18183122}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5561ms
500Internal Server Error73ms
Body
application/json7 / 7
OAuthCallbackDto
#validinvalidschema
13866185{
23900127 "properties": {
3192965 "codeVerifier": {
4192965 "type": "string"
5192965 },
6186737 "state": {
7186737 "type": "string"
8186737 },
9389895 "url": {
10389858 "minLength": 1,
11395637 "type": "string"
12389895 }
133900127 },
14399347 "required": [
15399347 "url"
16399347 ],
17404011 "type": "object"
183866185}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request31971ms
500Internal Server Error10184ms
401Unauthorized1401ms
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
307Temporary Redirect81ms
Responses
codedescriptionhitsavg
20032396ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5761ms
Authentication (admin) 1 operation 1 covered 0 partial 0 uncovered 0 not measured — #
Responses
codedescriptionhitsavg
2041484ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2871ms
Cluster groups 8 operations 8 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
20032812ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized6191ms
Path Parameters
id3 / 3
#validinvalidschema
1448137{
2448137 "format": "uuid",
3448137 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4585n/a "type": "string"
5448137}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5542ms
401Unauthorized311ms
Path Parameters
id3 / 3
#validinvalidschema
1474110{
2474110 "format": "uuid",
3474110 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4584n/a "type": "string"
5474110}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5481ms
401Unauthorized361ms
Path Parameters
id3 / 3
#validinvalidschema
1458108{
2458108 "format": "uuid",
3458108 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4566n/a "type": "string"
5458108}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5222ms
401Unauthorized441ms
Path Parameters
id3 / 3
#validinvalidschema
1447111{
2447111 "format": "uuid",
3447111 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4558n/a "type": "string"
5447111}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5202ms
401Unauthorized381ms
Path Parameters
id3 / 3
#validinvalidschema
1450107{
2450107 "format": "uuid",
3450107 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4557n/a "type": "string"
5450107}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5312ms
401Unauthorized261ms
Path Parameters
id3 / 3
#validinvalidschema
1420131{
2420131 "format": "uuid",
3420131 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4551n/a "type": "string"
5420131}
Body
application/json6 / 6
ClusterGroupRequestCreateDto
127141{
227125 "properties": {
327125 "userId": {
427111 "format": "uuid",
527111 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
628214 "type": "string"
727125 }
827125 },
92967 "required": [
102967 "userId"
112967 ],
123039 "type": "object"
1327141}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5381ms
401Unauthorized131ms
Path Parameters
id3 / 3
#validinvalidschema
1446117{
2446117 "format": "uuid",
3446117 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4563n/a "type": "string"
5446117}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5302ms
401Unauthorized331ms
Config (admin) 3 operations 2 covered 1 partial 0 uncovered 0 not measured 83% #
Responses
codedescriptionhitsavg
2001803ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3301ms
Body
application/json332 / 400
AdminConfigDto
#validinvalidschema
11601145{
21821120 "properties": {
312965 "backup": {
512965 },
612956 "ffmpeg": {
812956 },
91175126 "image": {
111175126 },
12124061 "integrityChecks": {
14124061 },
151066235 "job": {
171066235 },
18126437 "library": {
20126437 },
21128318 "logging": {
23128318 },
241120181 "machineLearning": {
261120181 },
27127427 "map": {
29127427 },
30128318 "metadata": {
32128318 },
33128318 "newVersionCheck": {
35128318 },
36125942 "nightlyTasks": {
38125942 },
39122477 "notifications": {
41122477 },
421158143 "oauth": {
441158143 },
4512965 "passwordLogin": {
4712965 },
48129011 "reverseGeocoding": {
50129011 },
51127823 "server": {
53127823 },
54127823 "storageTemplate": {
56127823 },
57127031 "templates": {
59127031 },
60129011 "theme": {
62129011 },
63128120 "trash": {
65128120 },
66128714 "user": {
68128714 }
691821120 },
70128025 "required": [
7113014 "backup",
7213014 "ffmpeg",
7313014 "integrityChecks",
7413014 "job",
7513014 "logging",
7613014 "machineLearning",
7713014 "map",
7813014 "reverseGeocoding",
7913014 "metadata",
8013014 "oauth",
8113014 "passwordLogin",
8213014 "storageTemplate",
8313014 "image",
8413014 "newVersionCheck",
8513014 "nightlyTasks",
8613014 "trash",
8713014 "theme",
8813014 "library",
8913014 "notifications",
9013014 "templates",
9113014 "server",
9213014 "user"
93128025 ],
9413050 "type": "object"
951601145}
Referenced Components (53)388 of 468 keywords
AdminConfigBackupsDto3 of 6 keywords
112965{
212965 "properties": {
312965 "database": {
512965 }
612965 },
713010 "required": [
813010 "database"
913010 ],
1013010 "type": "object"
1112965}
AdminConfigClipDto7 of 7 keywords
1127619{
2128010 "properties": {
312825 "enabled": {
412825 "type": "boolean"
512825 },
612845 "modelName": {
712845 "type": "string"
812845 }
9128010 },
1012864 "required": [
1112873 "enabled",
1212891 "modelName"
1312864 ],
1412905 "type": "object"
15127619}
AdminConfigDatabaseBackupDto3 of 10 keywords
112965{
212965 "properties": {
313010 "cronExpression": {
413010 "type": "string"
513010 },
613010 "enabled": {
713010 "type": "boolean"
813010 },
912965 "keepLastAmount": {
1013010 "maximum": 9007199254740991,
1112965 "minimum": 1,
1213010 "type": "integer"
1312965 }
1412965 },
1513010 "required": [
1613010 "enabled",
1713010 "cronExpression",
1813010 "keepLastAmount"
1913010 ],
2013010 "type": "object"
2112965}
AdminConfigDuplicateDetectionDto10 of 10 keywords
1127619{
2127812 "properties": {
312845 "enabled": {
412845 "type": "boolean"
512845 },
612827 "maxDistance": {
712845 "format": "double",
812831 "maximum": 0.1,
912831 "minimum": 0.001,
1012845 "type": "number"
1112827 }
12127812 },
1312882 "required": [
1412891 "enabled",
1512891 "maxDistance"
1612882 ],
1712905 "type": "object"
18127619}
AdminConfigFFmpegDto7 of 40 keywords
112956{
212965 "properties": {
313010 "accel": {
513010 },
613010 "accelDecode": {
713010 "type": "boolean"
813010 },
913010 "acceptedAudioCodecs": {
1013010 "items": {
1213010 },
1313010 "type": "array"
1413010 },
1513010 "acceptedContainers": {
1613010 "items": {
1813010 },
1913010 "type": "array"
2013010 },
2113010 "acceptedVideoCodecs": {
2213010 "items": {
2413010 },
2513010 "type": "array"
2613010 },
2713010 "bframes": {
2813010 "maximum": 16,
2913010 "minimum": -1,
3013010 "type": "integer"
3113010 },
3213010 "cqMode": {
3313010 "$ref": "#/components/schemas/CQMode"
3413010 },
3513010 "crf": {
3613010 "maximum": 51,
3713010 "minimum": 0,
3813010 "type": "integer"
3913010 },
4013001 "gopSize": {
4113001 "maximum": 9007199254740991,
4213010 "minimum": 0,
4313010 "type": "integer"
4413001 },
4513000 "maxBitrate": {
4613000 "type": "string"
4713000 },
4813010 "preferredHwDevice": {
4913010 "type": "string"
5013010 },
5113010 "preset": {
5213010 "type": "string"
5313010 },
5412992 "realtime": {
5612992 },
5713010 "refs": {
5813010 "maximum": 6,
5913010 "minimum": 0,
6013010 "type": "integer"
6113010 },
6213010 "targetAudioCodec": {
6413010 },
6512992 "targetResolution": {
6612992 "type": "string"
6712992 },
6813010 "targetVideoCodec": {
7013010 },
7113010 "temporalAQ": {
7213010 "type": "boolean"
7313010 },
7413010 "threads": {
7513010 "maximum": 9007199254740991,
7613010 "minimum": 0,
7713010 "type": "integer"
7813010 },
7913010 "tonemap": {
8113010 },
8213010 "transcode": {
8413010 },
8513010 "twoPass": {
8613010 "type": "boolean"
8713010 }
8812965 },
8913001 "required": [
9013010 "crf",
9113010 "threads",
9213010 "preset",
9313010 "targetVideoCodec",
9413010 "acceptedVideoCodecs",
9513010 "targetAudioCodec",
9613010 "acceptedAudioCodecs",
9713010 "acceptedContainers",
9813010 "targetResolution",
9913001 "maxBitrate",
10013010 "bframes",
10113010 "refs",
10213010 "gopSize",
10313010 "temporalAQ",
10413010 "cqMode",
10513010 "twoPass",
10613010 "preferredHwDevice",
10713010 "transcode",
10813010 "accel",
10913010 "accelDecode",
11013010 "tonemap",
11113010 "realtime"
11213001 ],
11313010 "type": "object"
11412956}
AdminConfigFFmpegRealtimeDto3 of 10 keywords
112992{
212992 "properties": {
312992 "enabled": {
412992 "type": "boolean"
512992 },
613010 "resolutions": {
713010 "items": {
913010 },
1013010 "type": "array"
1113010 },
1213010 "videoCodecs": {
1313010 "items": {
1513010 },
1613010 "type": "array"
1713010 }
1812992 },
1913010 "required": [
2013010 "enabled",
2113010 "videoCodecs",
2213010 "resolutions"
2313010 ],
2413010 "type": "object"
2512992}
AdminConfigFacesDto6 of 6 keywords
1128312{
212835 "properties": {
312835 "import": {
412835 "type": "boolean"
512835 }
612835 },
712882 "required": [
812882 "import"
912882 ],
1012905 "type": "object"
11128312}
AdminConfigFacialRecognitionDto18 of 18 keywords
1125342{
2125832 "properties": {
312845 "enabled": {
412845 "type": "boolean"
512845 },
612827 "maxDistance": {
712845 "format": "double",
812831 "maximum": 2,
912831 "minimum": 0.1,
1012845 "type": "number"
1112827 },
1212818 "minFaces": {
1312831 "maximum": 9007199254740991,
1412822 "minimum": 1,
1512836 "type": "integer"
1612818 },
1712827 "minScore": {
1812845 "format": "double",
1912831 "maximum": 1,
2012831 "minimum": 0.1,
2112845 "type": "number"
2212827 },
2312845 "modelName": {
2412845 "type": "string"
2512845 }
26125832 },
2712855 "required": [
2812891 "enabled",
2912891 "modelName",
3012891 "minScore",
3112891 "maxDistance",
3212891 "minFaces"
3312855 ],
3412905 "type": "object"
35125342}
AdminConfigGeneratedFullsizeImageDto11 of 11 keywords
1126035{
2126327 "properties": {
312845 "enabled": {
412845 "type": "boolean"
512845 },
612809 "format": {
812809 },
911505 "progressive": {
1011505 "type": "boolean"
1111505 },
1212818 "quality": {
1312831 "maximum": 100,
1412822 "minimum": 1,
1512836 "type": "integer"
1612818 }
17126327 },
1812873 "required": [
1912891 "enabled",
2012891 "format",
2112891 "quality"
2212873 ],
2312905 "type": "object"
24126035}
AdminConfigGeneratedImageDto13 of 13 keywords
1251476{
2252060 "properties": {
3256018 "format": {
5256018 },
6231110 "progressive": {
7231110 "type": "boolean"
8231110 },
9256216 "quality": {
1025662 "maximum": 100,
1125644 "minimum": 1,
12256612 "type": "integer"
13256216 },
14256216 "size": {
1525662 "maximum": 9007199254740991,
1625644 "minimum": 1,
17256612 "type": "integer"
18256216 }
19252060 },
2025746 "required": [
2125782 "format",
2225782 "quality",
2325782 "size"
2425746 ],
25258010 "type": "object"
26251476}
AdminConfigImageDto10 of 10 keywords
11175126{
21180116 "properties": {
312896 "colorspace": {
512896 },
612905 "extractEmbedded": {
712905 "type": "boolean"
812905 },
9126035 "fullsize": {
11126035 },
12125738 "preview": {
14125738 },
15125738 "thumbnail": {
17125738 }
181180116 },
1912915 "required": [
2012951 "thumbnail",
2112951 "preview",
2212951 "fullsize",
2312951 "colorspace",
2412951 "extractEmbedded"
2512915 ],
2612965 "type": "object"
271175126}
AdminConfigIntegrityChecksDto7 of 8 keywords
1124061{
2124358 "properties": {
3126634 "checksumFiles": {
5126634 },
612937 "missingFiles": {
812937 },
9128317 "untrackedFiles": {
11128317 }
12124358 },
1312983 "required": [
1413001 "missingFiles",
1513001 "untrackedFiles",
1613001 "checksumFiles"
1712983 ],
1813010 "type": "object"
19124061}
AdminConfigIntegrityChecksumJobDto14 of 14 keywords
1126634{
2127025 "properties": {
312895 "cronExpression": {
412895 "type": "string"
512895 },
612895 "enabled": {
712895 "type": "boolean"
812895 },
912877 "percentageLimit": {
1012895 "format": "double",
1112881 "maximum": 1,
1212881 "minimum": 0,
1312895 "type": "number"
1412877 },
1512868 "timeLimit": {
1612881 "maximum": 9007199254740991,
1712881 "minimum": 0,
1812886 "type": "integer"
1912868 }
20127025 },
2112914 "required": [
2212941 "enabled",
2312941 "cronExpression",
2412941 "timeLimit",
2512941 "percentageLimit"
2612914 ],
2712955 "type": "object"
28126634}
AdminConfigIntegrityJobDto7 of 7 keywords
1257624{
2258015 "properties": {
3258310 "cronExpression": {
4258310 "type": "string"
5258310 },
625885 "enabled": {
725885 "type": "boolean"
825885 }
9258015 },
1025914 "required": [
1125932 "enabled",
1225932 "cronExpression"
1325914 ],
1425955 "type": "object"
15257624}
AdminConfigJobDto20 of 20 keywords
11066235{
21081215 "properties": {
3127817 "backgroundTask": {
5127817 },
6127817 "editor": {
8127817 },
9127817 "faceDetection": {
11127817 },
12127817 "integrityCheck": {
14127817 },
15127817 "library": {
17127817 },
18127619 "metadataExtraction": {
20127619 },
21127817 "migration": {
23127817 },
24127817 "notifications": {
26127817 },
27127817 "ocr": {
29127817 },
30127817 "search": {
32127817 },
33127817 "sidecar": {
35127817 },
36127817 "smartSearch": {
38127817 },
39127817 "thumbnailGeneration": {
41127817 },
42127817 "videoConversion": {
44127817 },
45127817 "workflow": {
47127817 }
481081215 },
49128115 "required": [
5012951 "thumbnailGeneration",
5112951 "metadataExtraction",
5212951 "videoConversion",
5312951 "faceDetection",
5412951 "smartSearch",
5512951 "backgroundTask",
5612951 "migration",
5712951 "search",
5812951 "sidecar",
5912951 "library",
6012951 "notifications",
6112951 "ocr",
6212951 "workflow",
6312951 "editor",
6412951 "integrityCheck"
65128115 ],
6612965 "type": "object"
671066235}
AdminConfigJobSettingsDto8 of 8 keywords
119168257{
219168122 "properties": {
319168122 "concurrency": {
41919817 "maximum": 9007199254740991,
51918530 "minimum": 1,
61920090 "type": "integer"
719168122 }
819168122 },
91929030 "required": [
101929030 "concurrency"
111929030 ],
1219320105 "type": "object"
1319168257}
AdminConfigLibraryDto7 of 7 keywords
1126437{
2126630 "properties": {
3127817 "scan": {
5127817 },
6128213 "watch": {
8128213 }
9126630 },
1012942 "required": [
1112951 "scan",
1212951 "watch"
1312942 ],
1412965 "type": "object"
15126437}
AdminConfigLibraryScanDto7 of 7 keywords
1127817{
2128010 "properties": {
312845 "cronExpression": {
412845 "type": "string"
512845 },
612845 "enabled": {
712845 "type": "boolean"
812845 }
9128010 },
1012882 "required": [
1112891 "enabled",
1212891 "cronExpression"
1312882 ],
1412905 "type": "object"
15127817}
AdminConfigLibraryWatchDto6 of 6 keywords
1128213{
212825 "properties": {
312825 "enabled": {
412825 "type": "boolean"
512825 }
612825 },
712873 "required": [
812873 "enabled"
912873 ],
1012905 "type": "object"
11128213}
AdminConfigLoggingDto7 of 7 keywords
1128318{
2128511 "properties": {
312905 "enabled": {
412905 "type": "boolean"
512905 },
612896 "level": {
812896 }
9128511 },
1012942 "required": [
1112951 "enabled",
1212951 "level"
1312942 ],
1412965 "type": "object"
15128318}
AdminConfigMachineLearningAvailabilityChecksDto12 of 12 keywords
1126629{
2126921 "properties": {
312845 "enabled": {
412845 "type": "boolean"
512845 },
612818 "interval": {
712831 "maximum": 9007199254740991,
812831 "minimum": -9007199254740991,
912836 "type": "integer"
1012818 },
1112818 "timeout": {
1212831 "maximum": 9007199254740991,
1312831 "minimum": -9007199254740991,
1412836 "type": "integer"
1512818 }
16126921 },
1712873 "required": [
1812891 "enabled",
1912891 "timeout",
2012891 "interval"
2112873 ],
2212905 "type": "object"
23126629}
AdminConfigMachineLearningDto14 of 14 keywords
11120181{
21127169 "properties": {
3126629 "availabilityChecks": {
5126629 },
6127619 "clip": {
8127619 },
9127619 "duplicateDetection": {
11127619 },
1212905 "enabled": {
1312905 "type": "boolean"
1412905 },
15125342 "facialRecognition": {
17125342 },
18125144 "ocr": {
20125144 },
21128411 "urls": {
2212855 "items": {
2317285 "type": "string"
2412855 },
2512891 "minItems": 1,
2612905 "type": "array"
27128411 }
281127169 },
2912897 "required": [
3012951 "enabled",
3112951 "urls",
3212951 "availabilityChecks",
3312951 "clip",
3412951 "duplicateDetection",
3512951 "facialRecognition",
3612951 "ocr"
3712897 ],
3812965 "type": "object"
391120181}
AdminConfigMapDto10 of 10 keywords
1127427{
2127719 "properties": {
312896 "darkStyle": {
412891 "format": "uri",
512905 "type": "string"
612896 },
712887 "enabled": {
812887 "type": "boolean"
912887 },
1012896 "lightStyle": {
1112891 "format": "uri",
1212905 "type": "string"
1312896 }
14127719 },
1512933 "required": [
1612951 "enabled",
1712951 "lightStyle",
1812951 "darkStyle"
1912933 ],
2012965 "type": "object"
21127427}
AdminConfigMetadataDto6 of 6 keywords
1128318{
2128312 "properties": {
3128312 "faces": {
5128312 }
6128312 },
712951 "required": [
812951 "faces"
912951 ],
1012965 "type": "object"
11128318}
AdminConfigNewVersionCheckDto7 of 7 keywords
1128318{
2128511 "properties": {
312896 "channel": {
512896 },
612905 "enabled": {
712905 "type": "boolean"
812905 }
9128511 },
1012942 "required": [
1112951 "enabled",
1212951 "channel"
1312942 ],
1412965 "type": "object"
15128318}
AdminConfigNightlyTasksDto12 of 12 keywords
1125942{
2126531 "properties": {
312905 "clusterNewFaces": {
412905 "type": "boolean"
512905 },
612905 "databaseCleanup": {
712905 "type": "boolean"
812905 },
912905 "generateMemories": {
1012905 "type": "boolean"
1112905 },
1212905 "missingThumbnails": {
1312905 "type": "boolean"
1412905 },
1512896 "startTime": {
1612891 "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
1712905 "type": "string"
1812896 },
1912905 "syncQuotaUsage": {
2012905 "type": "boolean"
2112905 }
22126531 },
2312906 "required": [
2412951 "startTime",
2512951 "databaseCleanup",
2612951 "missingThumbnails",
2712951 "clusterNewFaces",
2812951 "generateMemories",
2912951 "syncQuotaUsage"
3012906 ],
3112965 "type": "object"
32125942}
AdminConfigNotificationsDto6 of 6 keywords
1122477{
2122471 "properties": {
3122471 "smtp": {
5122471 }
6122471 },
712951 "required": [
812951 "smtp"
912951 ],
1012965 "type": "object"
11122477}
AdminConfigOAuthDto32 of 32 keywords
11158143{
21179117 "properties": {
311655 "accountManagementUrl": {
411655 "type": "string"
511655 },
612905 "allowInsecureRequests": {
712905 "type": "boolean"
812905 },
912905 "autoLaunch": {
1012905 "type": "boolean"
1112905 },
1212905 "autoRegister": {
1312905 "type": "boolean"
1412905 },
1512905 "buttonText": {
1612905 "type": "string"
1712905 },
1812905 "clientId": {
1912905 "type": "string"
2012905 },
2112905 "clientSecret": {
2212905 "type": "string"
2312905 },
2412887 "defaultStorageQuota": {
2512641 "maximum": 9007199254740991,
2612641 "minimum": 0,
271295n/a "nullable": true,
2812905 "type": "integer"
2912887 },
3012905 "enabled": {
3112905 "type": "boolean"
3212905 },
3312905 "endSessionEndpoint": {
3412905 "type": "string"
3512905 },
3612905 "issuerUrl": {
3712905 "type": "string"
3812905 },
3912905 "mobileOverrideEnabled": {
4012905 "type": "boolean"
4112905 },
4212905 "mobileRedirectUri": {
4312905 "type": "string"
4412905 },
4512905 "profileSigningAlgorithm": {
4612905 "type": "string"
4712905 },
4812905 "prompt": {
4912905 "type": "string"
5012905 },
5112905 "roleClaim": {
5212905 "type": "string"
5312905 },
5412896 "scope": {
5512896 "type": "string"
5612896 },
5712905 "signingAlgorithm": {
5812905 "type": "string"
5912905 },
6012905 "storageLabelClaim": {
6112905 "type": "string"
6212905 },
6312905 "storageQuotaClaim": {
6412905 "type": "string"
6512905 },
6612878 "timeout": {
6712891 "maximum": 9007199254740991,
6812882 "minimum": 1,
6912896 "type": "integer"
7012878 },
7112896 "tokenEndpointAuthMethod": {
7312896 }
741179117 },
75127521 "required": [
7612951 "autoLaunch",
7712951 "autoRegister",
7812951 "buttonText",
7912951 "clientId",
8012951 "clientSecret",
8112951 "tokenEndpointAuthMethod",
8212951 "timeout",
8312951 "allowInsecureRequests",
8412951 "defaultStorageQuota",
8512951 "enabled",
8612951 "issuerUrl",
8712951 "scope",
8812951 "prompt",
8912951 "endSessionEndpoint",
9012951 "signingAlgorithm",
9112951 "profileSigningAlgorithm",
9212951 "storageLabelClaim",
9312951 "storageQuotaClaim",
9412951 "roleClaim",
9512951 "mobileOverrideEnabled",
9612951 "mobileRedirectUri"
97127521 ],
9812965 "type": "object"
991158143}
AdminConfigOcrDto18 of 18 keywords
1125144{
2125634 "properties": {
312845 "enabled": {
412845 "type": "boolean"
512845 },
612818 "maxResolution": {
712831 "maximum": 9007199254740991,
812822 "minimum": 1,
912836 "type": "integer"
1012818 },
1112809 "minDetectionScore": {
1212827 "format": "double",
1312811 "maximum": 1,
1412811 "minimum": 0.1,
1512827 "type": "number"
1612809 },
1712827 "minRecognitionScore": {
1812845 "format": "double",
1912831 "maximum": 1,
2012831 "minimum": 0.1,
2112845 "type": "number"
2212827 },
2312845 "modelName": {
2412845 "type": "string"
2512845 }
26125634 },
2712855 "required": [
2812891 "enabled",
2912891 "modelName",
3012891 "maxResolution",
3112891 "minDetectionScore",
3212891 "minRecognitionScore"
3312855 ],
3412905 "type": "object"
35125144}
AdminConfigPasswordLoginDto1 of 6 keywords
112965{
212960 "properties": {
312960 "enabled": {
412960 "type": "boolean"
512960 }
612960 },
712960 "required": [
812960 "enabled"
912960 ],
1012965 "type": "object"
1112965}
AdminConfigReverseGeocodingDto6 of 6 keywords
1129011{
212905 "properties": {
312905 "enabled": {
412905 "type": "boolean"
512905 }
612905 },
712951 "required": [
812951 "enabled"
912951 ],
1012965 "type": "object"
11129011}
AdminConfigServerDto8 of 8 keywords
1127823{
2128115 "properties": {
312905 "externalDomain": {
412905 "type": "string"
512905 },
612905 "loginPageMessage": {
712905 "type": "string"
812905 },
912905 "publicUsers": {
1012905 "type": "boolean"
1112905 }
12128115 },
1312933 "required": [
1412951 "externalDomain",
1512951 "loginPageMessage",
1612951 "publicUsers"
1712933 ],
1812965 "type": "object"
19127823}
AdminConfigSmtpDto9 of 9 keywords
1122471{
2122862 "properties": {
312845 "enabled": {
412845 "type": "boolean"
512845 },
612845 "from": {
712845 "type": "string"
812845 },
912845 "replyTo": {
1012845 "type": "string"
1112845 },
12124247 "transport": {
14124247 }
15122862 },
1612864 "required": [
1712891 "enabled",
1812891 "from",
1912891 "replyTo",
2012891 "transport"
2112864 ],
2212905 "type": "object"
23122471}
AdminConfigSmtpTransportDto13 of 13 keywords
1124247{
2125133 "properties": {
312785 "host": {
412785 "type": "string"
512785 },
612785 "ignoreCert": {
712785 "type": "boolean"
812785 },
912785 "password": {
1012785 "type": "string"
1112785 },
1212728 "port": {
1312741 "maximum": 65535,
1412741 "minimum": 0,
1512746 "type": "integer"
1612728 },
1712785 "secure": {
1812785 "type": "boolean"
1912785 },
2012785 "username": {
2112785 "type": "string"
2212785 }
23125133 },
2412759 "required": [
2512831 "ignoreCert",
2612831 "host",
2712804 "port",
2812831 "secure",
2912831 "username",
3012831 "password"
3112759 ],
3212845 "type": "object"
33124247}
AdminConfigStorageTemplateDto8 of 8 keywords
1127823{
2128115 "properties": {
312905 "enabled": {
412905 "type": "boolean"
512905 },
612905 "hashVerificationEnabled": {
712905 "type": "boolean"
812905 },
912905 "template": {
1012905 "type": "string"
1112905 }
12128115 },
1312933 "required": [
1412951 "enabled",
1512951 "hashVerificationEnabled",
1612951 "template"
1712933 ],
1812965 "type": "object"
19127823}
AdminConfigTemplateEmailsDto8 of 8 keywords
1127025{
2127317 "properties": {
312845 "albumInviteTemplate": {
412845 "type": "string"
512845 },
612845 "albumUpdateTemplate": {
712845 "type": "string"
812845 },
912827 "welcomeTemplate": {
1012827 "type": "string"
1112827 }
12127317 },
1312873 "required": [
1412891 "welcomeTemplate",
1512891 "albumInviteTemplate",
1612891 "albumUpdateTemplate"
1712873 ],
1812905 "type": "object"
19127025}
AdminConfigTemplatesDto6 of 6 keywords
1127031{
2127025 "properties": {
3127025 "email": {
5127025 }
6127025 },
712951 "required": [
812951 "email"
912951 ],
1012965 "type": "object"
11127031}
AdminConfigThemeDto6 of 6 keywords
1129011{
212905 "properties": {
312905 "customCss": {
412905 "type": "string"
512905 }
612905 },
712951 "required": [
812951 "customCss"
912951 ],
1012965 "type": "object"
11129011}
AdminConfigTrashDto9 of 9 keywords
1128120{
2128313 "properties": {
312878 "days": {
412891 "maximum": 9007199254740991,
512891 "minimum": 0,
612896 "type": "integer"
712878 },
812905 "enabled": {
912905 "type": "boolean"
1012905 }
11128313 },
1212942 "required": [
1312951 "enabled",
1412951 "days"
1512942 ],
1612965 "type": "object"
17128120}
AdminConfigUserDto8 of 8 keywords
1128714{
212878 "properties": {
312878 "deleteDelay": {
412891 "maximum": 9007199254740991,
512882 "minimum": 1,
612896 "type": "integer"
712878 }
812878 },
912951 "required": [
1012951 "deleteDelay"
1112951 ],
1212965 "type": "object"
13128714}
AudioCodec0 of 3 keywords
119790{
219790 "enum": [
31348n/a "mp3",
4237n/a "aac",
5199n/a "opus",
6195n/a "pcm_s16le"
719790 ],
819790 "type": "string"
919790}
CQMode0 of 3 keywords
113010{
213010 "enum": [
31144n/a "auto",
4120n/a "cqp",
537n/a "icq"
613010 ],
713010 "type": "string"
813010}
Colorspace3 of 3 keywords
112896{
212896 "enum": [
31167n/a "srgb",
4122n/a "p3"
512896 ],
612905 "type": "string"
712896}
HlsVideoResolution0 of 3 keywords
17150{
27150 "enum": [
3158n/a 480,
4143n/a 720,
5130n/a 1080,
6164n/a 1440,
7120n/a 2160
87150 ],
97150 "type": "integer"
107150}
ImageFormat3 of 3 keywords
1384027{
2384027 "enum": [
33736n/a "jpeg",
4104n/a "webp"
5384027 ],
6385215 "type": "string"
7384027}
LogLevel3 of 3 keywords
112896{
212896 "enum": [
31125n/a "verbose",
412n/a "debug",
591n/a "log",
626n/a "warn",
720n/a "error",
815n/a "fatal"
912896 ],
1012905 "type": "string"
1112896}
OAuthTokenEndpointAuthMethod3 of 3 keywords
112896{
212896 "enum": [
31253n/a "client_secret_post",
436n/a "client_secret_basic"
512896 ],
612905 "type": "string"
712896}
ReleaseChannel3 of 3 keywords
112896{
212896 "enum": [
31252n/a "stable",
437n/a "releaseCandidate"
512896 ],
612905 "type": "string"
712896}
ToneMapping0 of 3 keywords
113010{
213010 "enum": [
31226n/a "hable",
416n/a "mobius",
520n/a "reinhard",
639n/a "disabled"
713010 ],
813010 "type": "string"
913010}
TranscodeHWAccel0 of 3 keywords
113010{
213010 "enum": [
31145n/a "nvenc",
482n/a "qsv",
522n/a "vaapi",
624n/a "rkmpp",
728n/a "disabled"
813010 ],
913010 "type": "string"
1013010}
TranscodePolicy0 of 3 keywords
113010{
213010 "enum": [
31223n/a "all",
422n/a "optimal",
527n/a "bitrate",
619n/a "required",
710n/a "disabled"
813010 ],
913010 "type": "string"
1013010}
VideoCodec0 of 3 keywords
122930{
222930 "enum": [
31413n/a "h264",
4211n/a "hevc",
5343n/a "vp9",
6326n/a "av1"
722930 ],
822930 "type": "string"
922930}
VideoContainer0 of 3 keywords
15820{
25820 "enum": [
3138n/a "mov",
4139n/a "mp4",
5166n/a "ogg",
6139n/a "webm"
75820 ],
85820 "type": "string"
95820}
Responses
codedescriptionhitsavg
2007612ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request12523ms
401Unauthorized211ms
500Internal Server Error17ms
Examples
Body: application/json
""AdminConfigOAuthDto.accountManagementUrl
Responses
codedescriptionhitsavg
2001741ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3371ms
Config (public) 2 operations 2 covered 0 partial 0 uncovered 0 not measured — #
Responses
codedescriptionhitsavg
20084ms
Responses
codedescriptionhitsavg
20081ms
Config (user) 2 operations 2 covered 0 partial 0 uncovered 0 not measured — #
Responses
codedescriptionhitsavg
2001583ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3521ms
Responses
codedescriptionhitsavg
2001741ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3381ms
Database Backups (admin) 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json5 / 5
DatabaseBackupDeleteDto
#validinvalidschema
1327181{
2327119 "properties": {
3327119 "backups": {
432761 "items": {
51548630 "type": "string"
632761 },
738858 "type": "array"
8327119 }
9327119 },
1044653 "required": [
1144653 "backups"
1244653 ],
134999 "type": "object"
14327181}
Responses
codedescriptionhitsavg
200841ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized871ms
400Bad Request3571ms
Responses
codedescriptionhitsavg
20033812ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized7391ms
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request81ms
Body
multipart/form-data4 / 4
DatabaseBackupUploadDto
#validinvalidschema
1223n/a{
2123n/a "properties": {
3123n/a "file": {
4n/an/a "contentEncoding": "binary",
5123n/a "format": "binary",
6123n/a "type": "string"
7123n/a }
8123n/a },
9223n/a "type": "object"
10223n/a}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3031ms
500Internal Server Error512ms
401Unauthorized1931ms
Path Parameters
filename2 / 2
#validinvalidschema
174318{
274318 "pattern": "^[a-zA-Z0-9_\\-.]+$",
3761n/a "type": "string"
474318}
Responses
codedescriptionhitsavg
2004602ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2751ms
400Bad Request182ms
404Not Found82ms
Download 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
key1 / 1
#validinvalidschema
1279n/a{
2279n/a "type": "string"
3279n/a}
slug1 / 1
1191n/a{
2191n/a "type": "string"
3191n/a}
Body
application/json9 / 9
DownloadArchiveDto
1340178{
2345159 "properties": {
316097 "archiveName": {
416097 "type": "string"
516097 },
6350149 "assetIds": {
7350110 "items": {
8269239 "format": "uuid",
9269239 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
10508345 "type": "string"
11350110 },
1246039 "type": "array"
13350149 },
1475111 "edited": {
1575111 "type": "boolean"
1675111 }
17345159 },
1849910 "required": [
1949910 "assetIds"
2049910 ],
215099 "type": "object"
22340178}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error452ms
400Bad Request2312ms
401Unauthorized2651ms
Query Parameters
key1 / 1
#validinvalidschema
1208n/a{
2208n/a "type": "string"
3208n/a}
slug1 / 1
1181n/a{
2181n/a "type": "string"
3181n/a}
Body
application/json15 / 15
DownloadInfoDto
155358{
235449 "properties": {
310221 "albumId": {
41028 "format": "uuid",
51028 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
611013 "type": "string"
710221 },
815414 "archiveSize": {
91573 "maximum": 9007199254740991,
101573 "minimum": 1,
111599 "type": "integer"
1215414 },
1329016 "assetIds": {
142908 "items": {
15939 "format": "uuid",
16939 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
17485 "type": "string"
182908 },
192988 "type": "array"
2029016 },
216211 "userId": {
22623 "format": "uuid",
23623 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
24658 "type": "string"
256211 }
2635449 },
276029 "type": "object"
2855358}
Responses
codedescriptionhitsavg
2012582ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1601ms
400Bad Request2251ms
Duplicates 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json7 / 7
BulkIdsDto
#validinvalidschema
144443{
244420 "properties": {
344420 "ids": {
444410 "items": {
588 "format": "uuid",
688 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
7169 "type": "string"
844410 },
945410 "type": "array"
1044420 }
1144420 },
1246417 "required": [
1346417 "ids"
1446417 ],
154816 "type": "object"
1644443}
Responses
codedescriptionhitsavg
2043001ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1391ms
400Bad Request901ms
Responses
codedescriptionhitsavg
20034753ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5951ms
Body
application/json20 / 20
DuplicateResolveDto
#validinvalidschema
130186{
230129 "properties": {
330129 "groups": {
43179 "items": {
63179 },
71091 "minItems": 1,
811049 "type": "array"
930129 }
1030129 },
1115930 "required": [
1215930 "groups"
1315930 ],
1418927 "type": "object"
1530186}
Referenced Components (1)16 of 16 keywords
DuplicateResolveGroupDto16 of 16 keywords
133232{
236174 "properties": {
373136 "duplicateId": {
47347 "format": "uuid",
57347 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
612089 "type": "string"
773136 },
855154 "keepAssetIds": {
95581 "items": {
103248 "format": "uuid",
113248 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
1280475 "type": "string"
135581 },
1413673 "type": "array"
1555154 },
1654155 "trashAssetIds": {
175444 "items": {
1822173 "format": "uuid",
1922173 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
2019545 "type": "string"
215444 },
2298111 "type": "array"
2354155 }
2436174 },
252079 "required": [
262097 "duplicateId",
272097 "keepAssetIds",
282097 "trashAssetIds"
292079 ],
3021649 "type": "object"
3133232}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6751ms
Path Parameters
id3 / 3
#validinvalidschema
1634200{
2634200 "format": "uuid",
3634200 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4834n/a "type": "string"
5634200}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request7911ms
401Unauthorized431ms
Faces 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
id3 / 3
#validinvalidschema
141696{
241696 "format": "uuid",
341696 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4512n/a "type": "string"
541696}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4662ms
401Unauthorized471ms
Body
application/json30 / 30
AssetFaceCreateDto
#validinvalidschema
1109133{
2121109 "properties": {
32169 "assetId": {
42163 "format": "uuid",
52163 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
62196 "type": "string"
72169 },
820916 "height": {
92134 "maximum": 9007199254740991,
102143 "minimum": -9007199254740991,
112169 "type": "integer"
1220916 },
1321510 "imageHeight": {
142171 "maximum": 9007199254740991,
152171 "minimum": -9007199254740991,
162178 "type": "integer"
1721510 },
1821118 "imageWidth": {
192157 "maximum": 9007199254740991,
202193 "minimum": -9007199254740991,
212218 "type": "integer"
2221118 },
2321213 "personId": {
242126 "format": "uuid",
252126 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
262187 "type": "string"
2721213 },
2812513 "userId": {
291258 "format": "uuid",
301258 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
311335 "type": "string"
3212513 },
3320821 "width": {
342116 "maximum": 9007199254740991,
352152 "minimum": -9007199254740991,
3621613 "type": "integer"
3720821 },
3821015 "x": {
392123 "maximum": 9007199254740991,
402141 "minimum": -9007199254740991,
4121411 "type": "integer"
4221015 },
4320817 "y": {
442117 "maximum": 9007199254740991,
452162 "minimum": -9007199254740991,
462178 "type": "integer"
4720817 }
48121109 },
4921815 "required": [
502258 "personId",
512258 "assetId",
522294 "imageWidth",
532258 "imageHeight",
542258 "x",
552258 "y",
562294 "width",
572258 "height"
5821815 ],
592339 "type": "object"
60109133}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6071ms
401Unauthorized41ms
Path Parameters
id3 / 3
#validinvalidschema
144085{
244085 "format": "uuid",
344085 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4525n/a "type": "string"
544085}
Body
application/json4 / 4
AssetFaceDeleteDto
144655{
244617 "properties": {
344617 "force": {
444617 "type": "boolean"
544617 }
644617 },
746331 "required": [
846331 "force"
946331 ],
104947 "type": "object"
1144655}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5091ms
401Unauthorized161ms
Path Parameters
id3 / 3
#validinvalidschema
1376149{
2376149 "format": "uuid",
3376149 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4525n/a "type": "string"
5376149}
Body
application/json6 / 6
FaceDto
138482{
238452 "properties": {
338452 "id": {
438424 "format": "uuid",
538424 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
640828 "type": "string"
738452 }
838452 },
943618 "required": [
1043618 "id"
1143618 ],
1245412 "type": "object"
1338482}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5181ms
401Unauthorized71ms
Jobs 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
2001682ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3431ms
Body
application/json6 / 6
JobCreateDto
#validinvalidschema
1377155{
237754 "properties": {
337754 "name": {
537754 }
637754 },
743181 "required": [
843181 "name"
943181 ],
1051220 "type": "object"
11377155}
Referenced Components (1)3 of 3 keywords
ManualJobName3 of 3 keywords
137754{
237754 "enum": [
330n/a "person-cleanup",
4142n/a "tag-cleanup",
529n/a "user-cleanup",
616n/a "memory-cleanup",
78n/a "memory-create",
87n/a "backup-database",
924n/a "integrity-missing-files",
1010n/a "integrity-untracked-files",
1117n/a "integrity-checksum-mismatch",
1222n/a "integrity-missing-files-refresh",
1323n/a "integrity-untracked-files-refresh",
1424n/a "integrity-checksum-mismatch-refresh",
158n/a "integrity-missing-files-delete-all",
1612n/a "integrity-untracked-files-delete-all",
175n/a "integrity-checksum-mismatch-delete-all"
1837754 ],
194265 "type": "string"
2037754}
Responses
codedescriptionhitsavg
2042811ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized961ms
400Bad Request1951ms
Path Parameters
name2 / 2
QueueName
#validinvalidschema
15329{
25329 "enum": [
366n/a "thumbnailGeneration",
44n/a "metadataExtraction",
553n/a "videoConversion",
619n/a "faceDetection",
737n/a "facialRecognition",
812n/a "smartSearch",
914n/a "duplicateDetection",
1011n/a "backgroundTask",
1167n/a "storageTemplateMigration",
1258n/a "migration",
132n/a "search",
1419n/a "sidecar",
1516n/a "library",
167n/a "notifications",
1741n/a "backupDatabase",
1841n/a "ocr",
196n/a "workflow",
2014n/a "integrityCheck",
2145n/a "editor"
225329 ],
23541n/a "type": "string"
245329}
Body
application/json7 / 7
QueueCommandDto
145075{
245255 "properties": {
346342 "command": {
546342 },
617714 "force": {
717714 "type": "boolean"
817714 }
945255 },
1050515 "required": [
1150515 "command"
1250515 ],
135205 "type": "object"
1445075}
Referenced Components (1)3 of 3 keywords
QueueCommand3 of 3 keywords
146342{
246342 "enum": [
389n/a "start",
461n/a "pause",
518n/a "resume",
6263n/a "empty",
732n/a "clear-failed"
846342 ],
95005 "type": "string"
1046342}
Responses
codedescriptionhitsavg
2003812ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized451ms
400Bad Request1151ms
Libraries 8 operations 8 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
20033532ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5671ms
Body
application/json14 / 14
CreateLibraryDto
#validinvalidschema
1168102{
217782 "properties": {
312235 "exclusionPatterns": {
413019 "items": {
51684159 "type": "string"
613019 },
71409 "maxItems": 128,
81498 "type": "array"
912235 },
1011831 "importPaths": {
1113012 "items": {
12251292 "type": "string"
1313012 },
1412913 "maxItems": 128,
151427 "type": "array"
1611831 },
1714411 "name": {
181444 "minLength": 1,
191487 "type": "string"
2014411 },
2121238 "ownerId": {
2221219 "format": "uuid",
2321219 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
2423119 "type": "string"
2521238 }
2617782 },
2725014 "required": [
2825014 "ownerId"
2925014 ],
302646 "type": "object"
31168102}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error942ms
400Bad Request4511ms
401Unauthorized311ms
Path Parameters
id3 / 3
#validinvalidschema
154248{
254248 "format": "uuid",
354248 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4590n/a "type": "string"
554248}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5382ms
401Unauthorized521ms
Path Parameters
id3 / 3
#validinvalidschema
152258{
252258 "format": "uuid",
352258 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4580n/a "type": "string"
552258}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5202ms
401Unauthorized601ms
Path Parameters
id3 / 3
#validinvalidschema
162616{
262616 "format": "uuid",
362616 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4642n/a "type": "string"
562616}
Body
application/json10 / 10
UpdateLibraryDto
150954{
223844 "properties": {
321718 "exclusionPatterns": {
42208 "items": {
5186483 "type": "string"
62208 },
72244 "maxItems": 128,
82287 "type": "array"
921718 },
1016019 "importPaths": {
111668 "items": {
12207389 "type": "string"
131668 },
141677 "maxItems": 128,
151745 "type": "array"
1616019 },
1717213 "name": {
181728 "minLength": 1,
191805 "type": "string"
2017213 }
2123844 },
2255310 "type": "object"
2350954}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6081ms
401Unauthorized341ms
Path Parameters
id3 / 3
#validinvalidschema
151751{
251751 "format": "uuid",
351751 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4568n/a "type": "string"
551751}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5242ms
401Unauthorized441ms
Path Parameters
id3 / 3
#validinvalidschema
152542{
252542 "format": "uuid",
352542 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4567n/a "type": "string"
552542}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4982ms
401Unauthorized691ms
Path Parameters
id3 / 3
#validinvalidschema
160131{
260131 "format": "uuid",
360131 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4632n/a "type": "string"
560131}
Body
application/json8 / 8
ValidateLibraryDto
155158{
219447 "properties": {
315832 "exclusionPatterns": {
416616 "items": {
52081110 "type": "string"
616616 },
71739 "maxItems": 128,
81828 "type": "array"
915832 },
1016234 "importPaths": {
1116911 "items": {
12230083 "type": "string"
1316911 },
141728 "maxItems": 128,
1518016 "type": "array"
1616234 }
1719447 },
1859811 "type": "object"
1955158}
Responses
codedescriptionhitsavg
2004091ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized391ms
400Bad Request1841ms
Maintenance (admin) 9 operations 8 covered 0 partial 1 uncovered 0 not measured 72% #
Query Parameters
type2 / 2
IntegrityReport
#validinvalidschema
13916209{
23916209 "enum": [
31167n/a "untracked_file",
41654n/a "missing_file",
51095n/a "checksum_mismatch"
63916209 ],
74125n/a "type": "string"
83916209}
cursor1 / 1
12028n/a{
22028n/a "type": "string"
32028n/a}
limit4 / 4
11757366{
2178794 "exclusiveMinimum": true,
3185130 "maximum": 9007199254740991,
4178794 "minimum": 0,
51881242 "type": "integer"
61757366}
Responses
codedescriptionhitsavg
20018762ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error15932ms
400Bad Request5711ms
401Unauthorized2101ms
Examples
Query
500limit
Path Parameters
id3 / 3
#validinvalidschema
15515{
25515 "format": "uuid",
35515 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4520n/a "type": "string"
55515}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error51ms
400Bad Request5151ms
Path Parameters
id3 / 3
#validinvalidschema
14509{
24509 "format": "uuid",
34509 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4513n/a "type": "string"
54509}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found42ms
400Bad Request5091ms
Path Parameters
type2 / 2
IntegrityReport
#validinvalidschema
1265255{
2265255 "enum": [
371n/a "untracked_file",
4149n/a "missing_file",
545n/a "checksum_mismatch"
6265255 ],
7520n/a "type": "string"
8265255}
Responses
codedescriptionhitsavg
2001651ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1001ms
400Bad Request2551ms
Responses
codedescriptionhitsavg
2001951ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3171ms
Body
application/jsonno coverage data
SetMaintenanceModeDto
#validinvalidschema
100{
200 "properties": {
300 "action": {
500 },
600 "restoreBackupFilename": {
700 "type": "string"
800 }
900 },
1000 "required": [
1100 "action"
1200 ],
1300 "type": "object"
1400}
Referenced Components (1)0 of 3 keywords
MaintenanceAction0 of 3 keywords
100{
200 "enum": [
30n/a "start",
40n/a "end",
50n/a "select_database_restore",
60n/a "restore_database"
700 ],
800 "type": "string"
900}
Expected Responses
codedescriptionhitsavg
2010never seen
Responses
codedescriptionhitsavg
2001831ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3291ms
Body
application/json3 / 3
MaintenanceLoginDto
#validinvalidschema
1321226{
2170126 "properties": {
3170126 "token": {
4170126 "type": "string"
5170126 }
6170126 },
7447100 "type": "object"
8321226}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5691ms
Responses
codedescriptionhitsavg
20081ms
Map 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
isArchived1 / 1
#validinvalidschema
111859{
211859 "type": "boolean"
311859}
isFavorite1 / 1
112649{
212649 "type": "boolean"
312649}
fileCreatedAfter3 / 3
119347{
219347 "format": "date-time",
319545 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
4240n/a "type": "string"
519347}
fileCreatedBefore3 / 3
121235{
221235 "format": "date-time",
321433 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
4247n/a "type": "string"
521235}
withPartners1 / 1
112527{
212527 "type": "boolean"
312527}
withSharedAlbums1 / 1
110334{
210334 "type": "boolean"
310334}
Responses
codedescriptionhitsavg
2004012ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized361ms
400Bad Request1561ms
Examples
Query
"2024-01-01T00:00:00.000Z"fileCreatedAfter
"2024-01-01T00:00:00.000Z"fileCreatedBefore
Query Parameters
lat2 / 2
#validinvalidschema
146251{
246251 "format": "double",
346251 "type": "number"
446251}
lon2 / 2
146144{
246144 "format": "double",
346144 "type": "number"
446144}
Responses
codedescriptionhitsavg
2002076ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized631ms
400Bad Request2481ms
500Internal Server Error12ms
Memories 8 operations 8 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
id3 / 3
#validinvalidschema
1235124{
2235124 "format": "uuid",
3235124 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
42375n/a "type": "string"
5235124}
type2 / 2
MemoryType
196026{
296026 "enum": [
3510n/a "on_this_day",
4450n/a "birthday"
596026 ],
6986n/a "type": "string"
796026}
for3 / 3
1125520{
2125520 "format": "date",
3125520 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
41275n/a "type": "string"
5125520}
isTrashed1 / 1
1100518{
2100518 "type": "boolean"
3100518}
isSaved1 / 1
199518{
299518 "type": "boolean"
399518}
isUpcoming1 / 1
191517{
291517 "type": "boolean"
391517}
size3 / 3
195421{
29582 "maximum": 9007199254740991,
39564 "minimum": 1,
496015 "type": "integer"
595421}
page3 / 3
1101020{
210142 "maximum": 9007199254740991,
310124 "minimum": 1,
4101614 "type": "integer"
5101020}
order2 / 2
MemorySearchOrder
192721{
292721 "enum": [
3341n/a "asc",
4284n/a "desc",
5302n/a "random"
692721 ],
7948n/a "type": "string"
892721}
Responses
codedescriptionhitsavg
20025423ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1571ms
400Bad Request1551ms
500Internal Server Error282ms
Examples
Query
"2024-01-01"for
Body
application/json34 / 34
MemoryCreateDto
#validinvalidschema
11838190{
21843171 "properties": {
338561 "assetIds": {
438536 "items": {
516735 "format": "uuid",
616735 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
720296 "type": "string"
838536 },
942125 "type": "array"
1038561 },
11193478 "data": {
13193478 },
146459 "hideAt": {
156452 "format": "date-time",
166461 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
176477 "type": "string",
186459 },
1962211 "isSaved": {
2062211 "type": "boolean"
2162211 },
22198725 "memoryAt": {
2319876 "format": "date-time",
2419885 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
25199319 "type": "string"
26198725 },
2760218 "seenAt": {
2860211 "format": "date-time",
2960310 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
306137 "type": "string"
3160218 },
3257410 "showAt": {
335743 "format": "date-time",
345752 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
355777 "type": "string",
3657410 },
37199716 "type": {
39199716 }
401843171 },
4120097 "required": [
4220133 "type",
4320124 "data",
4420124 "memoryAt"
4520097 ],
46201612 "type": "object"
471838190}
Referenced Components (2)15 of 15 keywords
MemoryDataDto12 of 12 keywords
1193478{
2194246 "properties": {
358017 "personId": {
458011 "format": "uuid",
558011 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
65916 "type": "string"
758017 },
87419 "personName": {
97419 "type": "string"
107419 },
11195723 "year": {
1219633 "maximum": 9999,
1319606 "minimum": 1000,
14196515 "type": "integer"
15195723 }
16194246 },
17198012 "required": [
18198012 "year"
19198012 ],
20199220 "type": "object"
21193478}
MemoryType3 of 3 keywords
1199716{
2199716 "enum": [
31139n/a "on_this_day",
4858n/a "birthday"
5199716 ],
620085 "type": "string"
7199716}
Responses
codedescriptionhitsavg
20111575ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request9012ms
401Unauthorized951ms
Examples
Body: application/json
"2024-01-01T00:00:00.000Z"MemoryCreateDto.hideAt
"2024-01-01T00:00:00.000Z"MemoryCreateDto.memoryAt
"2024-01-01T00:00:00.000Z"MemoryCreateDto.seenAt
"2024-01-01T00:00:00.000Z"MemoryCreateDto.showAt
Query Parameters
id3 / 3
#validinvalidschema
112138{
212138 "format": "uuid",
312138 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4159n/a "type": "string"
512138}
type2 / 2
MemoryType
112746{
212746 "enum": [
395n/a "on_this_day",
432n/a "birthday"
512746 ],
6173n/a "type": "string"
712746}
for3 / 3
121932{
221932 "format": "date",
321932 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
4251n/a "type": "string"
521932}
isTrashed1 / 1
112724{
212724 "type": "boolean"
312724}
isSaved1 / 1
113232{
213232 "type": "boolean"
313232}
isUpcoming1 / 1
114122{
214122 "type": "boolean"
314122}
size3 / 3
112343{
21376 "maximum": 9007199254740991,
312914 "minimum": 1,
414323 "type": "integer"
512343}
page3 / 3
113326{
21452 "maximum": 9007199254740991,
313512 "minimum": 1,
414712 "type": "integer"
513326}
order2 / 2
MemorySearchOrder
114021{
214021 "enum": [
378n/a "asc",
431n/a "desc",
531n/a "random"
614021 ],
7161n/a "type": "string"
814021}
Responses
codedescriptionhitsavg
2004341ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized241ms
400Bad Request1871ms
Examples
Query
"2024-01-01"for
Path Parameters
id3 / 3
#validinvalidschema
1729{
2729 "format": "uuid",
3729 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
481n/a "type": "string"
5729}
Responses
codedescriptionhitsavg
204495ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized91ms
400Bad Request231ms
Path Parameters
id3 / 3
#validinvalidschema
153541{
253541 "format": "uuid",
353541 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4576n/a "type": "string"
553541}
Responses
codedescriptionhitsavg
2004542ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized431ms
400Bad Request792ms
Path Parameters
id3 / 3
#validinvalidschema
155344{
255344 "format": "uuid",
355344 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4597n/a "type": "string"
555344}
Body
application/json9 / 9
MemoryUpdateDto
150857{
241048 "properties": {
330120 "isSaved": {
430120 "type": "boolean"
530120 },
629224 "memoryAt": {
729212 "format": "date-time",
829311 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
930412 "type": "string"
1029224 },
1121127 "seenAt": {
1221112 "format": "date-time",
1321211 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
1422315 "type": "string"
1521127 }
1641048 },
175569 "type": "object"
1850857}
Responses
codedescriptionhitsavg
2003394ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2261ms
401Unauthorized321ms
Examples
Body: application/json
"2024-01-01T00:00:00.000Z"MemoryUpdateDto.memoryAt
"2024-01-01T00:00:00.000Z"MemoryUpdateDto.seenAt
Path Parameters
id3 / 3
#validinvalidschema
115825{
215825 "format": "uuid",
315825 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4183n/a "type": "string"
515825}
Body
application/json7 / 7
BulkIdsDto
112328{
212318 "properties": {
312318 "ids": {
412312 "items": {
51626 "format": "uuid",
61626 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
716831 "type": "string"
812312 },
91356 "type": "array"
1012318 }
1112318 },
121414 "required": [
131414 "ids"
141414 ],
151456 "type": "object"
1612328}
Responses
codedescriptionhitsavg
200642ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized191ms
400Bad Request1001ms
Path Parameters
id3 / 3
#validinvalidschema
151345{
251345 "format": "uuid",
351345 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4558n/a "type": "string"
551345}
Body
application/json7 / 7
BulkIdsDto
146742{
246717 "properties": {
346717 "ids": {
446710 "items": {
54232 "format": "uuid",
64232 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
742514 "type": "string"
846710 },
94777 "type": "array"
1046717 }
1146717 },
1248420 "required": [
1348420 "ids"
1448420 ],
155045 "type": "object"
1646742}
Responses
codedescriptionhitsavg
2003982ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized231ms
400Bad Request1371ms
Notifications 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json8 / 8
NotificationDeleteAllDto
#validinvalidschema
199100{
29956 "properties": {
39956 "ids": {
410029 "items": {
514683 "format": "uuid",
614683 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
722927 "type": "string"
810029 },
91281 "minItems": 1,
1012926 "type": "array"
119956 }
129956 },
1315531 "required": [
1415531 "ids"
1515531 ],
1618613 "type": "object"
1799100}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5432ms
401Unauthorized91ms
Query Parameters
id3 / 3
#validinvalidschema
1741256{
2741256 "format": "uuid",
3741256 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4997n/a "type": "string"
5741256}
level2 / 2
NotificationLevel
1979202{
2979202 "enum": [
3271n/a "success",
4228n/a "error",
5228n/a "warning",
6252n/a "info"
7979202 ],
81181n/a "type": "string"
9979202}
type2 / 2
NotificationType
1967295{
2967295 "enum": [
3185n/a "JobFailed",
4131n/a "BackupFailed",
5119n/a "SystemMessage",
6137n/a "AlbumInvite",
7141n/a "AlbumUpdate",
8116n/a "ClusterGroupRequest",
9138n/a "Custom"
10967295 ],
111262n/a "type": "string"
12967295}
unread1 / 1
1950151{
2950151 "type": "boolean"
3950151}
Responses
codedescriptionhitsavg
20023502ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1471ms
400Bad Request4272ms
Body
application/json12 / 12
NotificationUpdateAllDto
#validinvalidschema
191116{
297104 "properties": {
39897 "ids": {
49946 "items": {
5134201 "format": "uuid",
6134201 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
7335117 "type": "string"
89946 },
91441 "minItems": 1,
1014550 "type": "array"
119897 },
128469 "readAt": {
137523 "format": "date-time",
14153n/a "nullable": true,
157622 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
1610746 "type": "string"
178469 }
1897104 },
191957 "required": [
201957 "ids"
211957 ],
222025 "type": "object"
2391116}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5451ms
401Unauthorized51ms
Examples
Body: application/json
"2024-01-01T00:00:00.000Z"NotificationUpdateAllDto.readAt
Path Parameters
id3 / 3
#validinvalidschema
1399146{
2399146 "format": "uuid",
3399146 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4545n/a "type": "string"
5399146}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5012ms
401Unauthorized441ms
Path Parameters
id3 / 3
#validinvalidschema
1393152{
2393152 "format": "uuid",
3393152 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4545n/a "type": "string"
5393152}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5172ms
401Unauthorized281ms
Path Parameters
id3 / 3
#validinvalidschema
150263{
250263 "format": "uuid",
350263 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4565n/a "type": "string"
550263}
Body
application/json6 / 6
NotificationUpdateDto
148148{
213335 "properties": {
313335 "readAt": {
412412 "format": "date-time",
5168n/a "nullable": true,
612511 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
714523 "type": "string"
813335 }
913335 },
1051613 "type": "object"
1148148}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5451ms
401Unauthorized201ms
Examples
Body: application/json
"2024-01-01T00:00:00.000Z"NotificationUpdateDto.readAt
Notifications (admin) 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json21 / 21
NotificationCreateDto
#validinvalidschema
120479{
220968 "properties": {
31606 "data": {
490n/a "additionalProperties": {},
51606 "type": "object"
61606 },
715719 "description": {
8176n/a "nullable": true,
915719 "type": "string"
1015719 },
111569 "level": {
131569 },
1415120 "readAt": {
1512716 "format": "date-time",
16171n/a "nullable": true,
1712815 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
181674 "type": "string"
1915120 },
2026013 "title": {
2126013 "type": "string"
2226013 },
231536 "type": {
251536 },
2625817 "userId": {
2725812 "format": "uuid",
2825812 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
292705 "type": "string"
3025817 }
3120968 },
322726 "required": [
332735 "title",
342753 "userId"
352726 ],
362785 "type": "object"
3720479}
Referenced Components (2)6 of 6 keywords
NotificationLevel3 of 3 keywords
11569{
21569 "enum": [
377n/a "success",
420n/a "error",
528n/a "warning",
631n/a "info"
71569 ],
81605 "type": "string"
91569}
NotificationType3 of 3 keywords
11536{
21536 "enum": [
371n/a "JobFailed",
420n/a "BackupFailed",
513n/a "SystemMessage",
66n/a "AlbumInvite",
713n/a "AlbumUpdate",
86n/a "ClusterGroupRequest",
924n/a "Custom"
101536 ],
111545 "type": "string"
121536}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1512ms
400Bad Request3981ms
401Unauthorized541ms
Examples
Body: application/json
"2024-01-01T00:00:00.000Z"NotificationCreateDto.readAt
Path Parameters
name1 / 1
#validinvalidschema
1546n/a{
2546n/a "type": "string"
3546n/a}
Body
application/json4 / 4
TemplateDto
143379{
243325 "properties": {
343325 "template": {
443325 "type": "string"
543325 }
643325 },
745847 "required": [
845847 "template"
945847 ],
105057 "type": "object"
1143379}
Responses
codedescriptionhitsavg
2003153ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1181ms
400Bad Request1132ms
Body
application/json18 / 18
AdminConfigSmtpDto
#validinvalidschema
13968{
24359 "properties": {
3965 "enabled": {
4965 "type": "boolean"
5965 },
6965 "from": {
7965 "type": "string"
8965 },
9965 "replyTo": {
10965 "type": "string"
11965 },
125744 "transport": {
145744 }
154359 },
16984 "required": [
171011 "enabled",
181011 "from",
191011 "replyTo",
201011 "transport"
21984 ],
221025 "type": "object"
233968}
Referenced Components (1)13 of 13 keywords
AdminConfigSmtpTransportDto13 of 13 keywords
15744{
26333 "properties": {
3905 "host": {
4905 "type": "string"
5905 },
6905 "ignoreCert": {
7905 "type": "boolean"
8905 },
9905 "password": {
10905 "type": "string"
11905 },
12878 "port": {
13891 "maximum": 65535,
14891 "minimum": 0,
15896 "type": "integer"
16878 },
17905 "secure": {
18905 "type": "boolean"
19905 },
20905 "username": {
21905 "type": "string"
22905 }
236333 },
24906 "required": [
25951 "ignoreCert",
26951 "host",
27951 "port",
28951 "secure",
29951 "username",
30951 "password"
31906 ],
32965 "type": "object"
335744}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request113356ms
Partners 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
direction2 / 2
PartnerDirection
#validinvalidschema
13350305{
23350305 "enum": [
31873n/a "shared-by",
41477n/a "shared-with"
53350305 ],
63655n/a "type": "string"
73350305}
Responses
codedescriptionhitsavg
20031712ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1791ms
400Bad Request3061ms
Body
application/json6 / 6
PartnerCreateDto
#validinvalidschema
1217157{
2217115 "properties": {
3217115 "sharedWithId": {
421796 "format": "uuid",
521796 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
631319 "type": "string"
7217115 }
8217115 },
933224 "required": [
1033224 "sharedWithId"
1133224 ],
1235618 "type": "object"
13217157}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5211ms
401Unauthorized211ms
Path Parameters
id3 / 3
#validinvalidschema
1453127{
2453127 "format": "uuid",
3453127 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4580n/a "type": "string"
5453127}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5322ms
401Unauthorized481ms
Path Parameters
id3 / 3
#validinvalidschema
11693264{
21693264 "format": "uuid",
31693264 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
41957n/a "type": "string"
51693264}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request18602ms
401Unauthorized971ms
Path Parameters
id3 / 3
#validinvalidschema
1449121{
2449121 "format": "uuid",
3449121 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4570n/a "type": "string"
5449121}
Body
application/json4 / 4
PartnerUpdateDto
147747{
24779 "properties": {
34779 "inTimeline": {
44779 "type": "boolean"
54779 }
64779 },
748628 "required": [
848628 "inTimeline"
948628 ],
1051410 "type": "object"
1147747}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5511ms
401Unauthorized191ms
People 15 operations 15 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json8 / 8
PeopleDeleteDto
#validinvalidschema
1213285{
2230244 "properties": {
3218239 "ids": {
4218156 "items": {
520289 "format": "uuid",
620289 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
7309508 "type": "string"
8218156 },
937483 "type": "array"
10218239 },
11230223 "userId": {
12230223 "type": "string"
13230223 }
14230244 },
1545727 "required": [
1645727 "ids"
1745727 ],
1848414 "type": "object",
19213285}
Responses
codedescriptionhitsavg
2041522ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized511ms
400Bad Request3292ms
500Internal Server Error32ms
Query Parameters
withHidden1 / 1
#validinvalidschema
111638{
211638 "type": "boolean"
311638}
closestPersonId3 / 3
116656{
216656 "format": "uuid",
316656 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4222n/a "type": "string"
516656}
closestAssetId3 / 3
118553{
218553 "format": "uuid",
318553 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4238n/a "type": "string"
518553}
page3 / 3
118445{
21956 "maximum": 9007199254740991,
319011 "minimum": 1,
420128 "type": "integer"
518445}
size3 / 3
113254{
215019 "maximum": 1000,
315118 "minimum": 1,
416917 "type": "integer"
513254}
sharedById3 / 3
117832{
217832 "format": "uuid",
317832 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
4210n/a "type": "string"
517832}
sharedWithId3 / 3
118653{
218653 "format": "uuid",
318653 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
4239n/a "type": "string"
518653}
isFavorite1 / 1
120420{
220420 "type": "boolean"
320420}
isHidden1 / 1
120128{
220128 "type": "boolean"
320128}
name1 / 1
1198n/a{
2198n/a "type": "string"
3198n/a}
Responses
codedescriptionhitsavg
2002404ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found382ms
400Bad Request2431ms
401Unauthorized1231ms
Examples
Query
1page
500size
Body
application/json11 / 11
PersonCreateDto
#validinvalidschema
13672203{
22565171 "properties": {
3164992 "birthDate": {
4137031 "format": "date",
51741n/a "nullable": true,
6168061 "type": "string"
7164992 },
8167372 "color": {
91745n/a "nullable": true,
10136421 "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
11169451 "type": "string"
12167372 },
13159041 "isFavorite": {
14159041 "type": "boolean"
15159041 },
16163637 "isHidden": {
17163637 "type": "boolean"
18163637 },
19168628 "name": {
20168628 "type": "string"
21168628 }
222565171 },
23384332 "type": "object"
243672203}
Responses
codedescriptionhitsavg
20134407ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1351ms
400Bad Request3961ms
500Internal Server Error136ms
Body
application/json26 / 26
PeopleUpdateDto
#validinvalidschema
1250241{
2250214 "properties": {
3250214 "people": {
4250205 "items": {
6250205 },
74559 "type": "array"
8250214 }
9250214 },
1046417 "required": [
1146417 "people"
1246417 ],
1348110 "type": "object"
14250241}
Referenced Components (1)23 of 23 keywords
PeopleUpdateItem23 of 23 keywords
1146325{
2148313 "properties": {
321451 "birthDate": {
41512 "format": "date",
5265n/a "nullable": true,
621649 "type": "string"
721451 },
821520 "color": {
9235n/a "nullable": true,
101173 "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
1121817 "type": "string"
1221520 },
1387218 "featureFaceAssetId": {
148754 "format": "uuid",
158754 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
16141164 "type": "string"
1787218 },
18272187 "id": {
1927280 "format": "uuid",
2027280 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
21352107 "type": "string"
22272187 },
232395 "isFavorite": {
242395 "type": "boolean"
252395 },
262067 "isHidden": {
272067 "type": "boolean"
282067 },
292115 "name": {
302115 "type": "string"
312115 },
3219643 "userId": {
3319638 "format": "uuid",
3419638 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
352345 "type": "string"
3619643 }
37148313 },
384593 "required": [
394593 "id"
404593 ],
414629 "type": "object"
42146325}
Responses
codedescriptionhitsavg
2002142ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized351ms
400Bad Request3181ms
Body
application/json7 / 7
MergePersonDto
#validinvalidschema
11395146{
2139566 "properties": {
3139566 "ids": {
4139554 "items": {
5300593 "format": "uuid",
6300593 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
73098335 "type": "string"
8139554 },
9144912 "type": "array"
10139566 }
11139566 },
12146160 "required": [
13146160 "ids"
14146160 ],
15152120 "type": "object"
161395146}
Responses
codedescriptionhitsavg
2006133ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request8541ms
401Unauthorized1421ms
Body
application/json13 / 13
PersonUsersDeleteDto
#validinvalidschema
1311184{
2311179 "items": {
32002196 "properties": {
4211179 "personId": {
5211169 "format": "uuid",
6211169 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
7218010 "type": "string"
8211179 },
999274 "sharedById": {
1099267 "format": "uuid",
1199267 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
1210597 "type": "string"
1399274 },
14212653 "sharedWithId": {
15212647 "format": "uuid",
16212647 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
1721736 "type": "string"
18212653 }
192002196 },
20217127 "required": [
2121908 "personId",
22217919 "sharedWithId"
23217127 ],
2421986 "type": "object"
25311179 },
264905 "type": "array"
27311184}
Responses
codedescriptionhitsavg
200321ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3582ms
401Unauthorized1431ms
Query Parameters
personId3 / 3
#validinvalidschema
177183{
277183 "format": "uuid",
377183 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
4854n/a "type": "string"
577183}
direction2 / 2
SharingDirection
140779{
240779 "enum": [
3281n/a "shared-by",
4126n/a "shared-with"
540779 ],
6486n/a "type": "string"
740779}
sharedById3 / 3
133079{
233079 "format": "uuid",
333079 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
4409n/a "type": "string"
533079}
sharedWithId3 / 3
133126{
233126 "format": "uuid",
333126 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
4357n/a "type": "string"
533126}
role2 / 2
PersonUserRole
137942{
237942 "enum": [
3192n/a "read",
488n/a "write",
599n/a "admin"
637942 ],
7421n/a "type": "string"
837942}
Responses
codedescriptionhitsavg
2005642ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2221ms
400Bad Request1571ms
Body
application/json17 / 17
PeopleUsersUpsertDto
#validinvalidschema
1408121{
242095 "properties": {
322961 "personIds": {
422945 "items": {
5350157 "format": "uuid",
6350157 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
7507118 "type": "string"
822945 },
927416 "type": "array"
1022961 },
115067 "role": {
135067 },
1447233 "sharedWithIds": {
1547218 "items": {
1697729 "format": "uuid",
1797729 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
18100634 "type": "string"
1947218 },
2049015 "type": "array"
2147233 },
222238 "type": {
242238 }
2542095 },
2650314 "required": [
2750512 "sharedWithIds",
285134 "role"
2950314 ],
3051712 "type": "object"
31408121}
Referenced Components (2)6 of 6 keywords
PeopleUsersUpsertType3 of 3 keywords
12238{
22238 "enum": [
3223n/a "everyone"
42238 ],
52265 "type": "string"
62238}
PersonUserRole3 of 3 keywords
15067{
25067 "enum": [
3353n/a "read",
478n/a "write",
575n/a "admin"
65067 ],
75085 "type": "string"
85067}
Responses
codedescriptionhitsavg
2001172ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized501ms
400Bad Request3942ms
Path Parameters
id3 / 3
#validinvalidschema
170857{
270857 "format": "uuid",
370857 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4765n/a "type": "string"
570857}
Body
application/json3 / 3
PersonDeleteDto
161220{
24709 "properties": {
34709 "userId": {
44709 "type": "string"
54709 }
64709 },
762111 "type": "object",
861220}
Responses
codedescriptionhitsavg
204212ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized461ms
400Bad Request6872ms
500Internal Server Error302ms
Examples
Body: application/json
{}PersonDeleteDto
Path Parameters
id3 / 3
#validinvalidschema
149437{
249437 "format": "uuid",
349437 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4531n/a "type": "string"
549437}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4812ms
401Unauthorized501ms
Path Parameters
id3 / 3
#validinvalidschema
167535{
267535 "format": "uuid",
367535 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4710n/a "type": "string"
567535}
Body
application/json17 / 17
PersonUpdateDto
142257{
241647 "properties": {
31756 "birthDate": {
41462 "format": "date",
5181n/a "nullable": true,
61774 "type": "string"
71756 },
816012 "color": {
9172n/a "nullable": true,
101426 "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
111666 "type": "string"
1216012 },
134128 "featureFaceAssetId": {
144123 "format": "uuid",
154123 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
164155 "type": "string"
174128 },
181596 "isFavorite": {
191596 "type": "boolean"
201596 },
211765 "isHidden": {
221765 "type": "boolean"
231765 },
241565 "name": {
251565 "type": "string"
261565 },
274138 "userId": {
284133 "format": "uuid",
294133 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
304165 "type": "string"
314138 }
3241647 },
3346910 "type": "object"
3442257}
Responses
codedescriptionhitsavg
20086ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6671ms
401Unauthorized351ms
Path Parameters
id3 / 3
#validinvalidschema
188844{
288844 "format": "uuid",
388844 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4932n/a "type": "string"
588844}
Body
application/json7 / 7
MergePersonDto
184341{
284324 "properties": {
384324 "ids": {
484313 "items": {
5179842 "format": "uuid",
6179842 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
718407 "type": "string"
884313 },
985611 "type": "array"
1084324 }
1184324 },
128677 "required": [
138677 "ids"
148677 ],
1587410 "type": "object"
1684341}
Responses
codedescriptionhitsavg
2006972ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1951ms
401Unauthorized401ms
Path Parameters
id3 / 3
#validinvalidschema
156130{
256130 "format": "uuid",
356130 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4591n/a "type": "string"
556130}
Body
application/json17 / 17
AssetFaceUpdateDto
132873{
232849 "properties": {
332849 "data": {
432837 "items": {
632837 },
736512 "type": "array"
832849 }
932849 },
1037719 "required": [
1137719 "data"
1237719 ],
133965 "type": "object"
1432873}
Referenced Components (1)14 of 14 keywords
AssetFaceUpdateItem14 of 14 keywords
1971{
21155 "properties": {
32540 "assetId": {
42520 "format": "uuid",
52520 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
64520 "type": "string"
72540 },
82441 "personId": {
92427 "format": "uuid",
102427 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
115114 "type": "string"
122441 },
132131 "userId": {
142116 "format": "uuid",
152116 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
163715 "type": "string"
172131 }
181155 },
19644 "required": [
20653 "personId",
21653 "assetId"
22644 ],
236812 "type": "object"
24971}
Responses
codedescriptionhitsavg
200762ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized171ms
400Bad Request4981ms
Path Parameters
id3 / 3
#validinvalidschema
173838{
273838 "format": "uuid",
373838 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4776n/a "type": "string"
573838}
Responses
codedescriptionhitsavg
2002543ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized591ms
400Bad Request4632ms
Path Parameters
id3 / 3
#validinvalidschema
168848{
268848 "format": "uuid",
368848 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4736n/a "type": "string"
568848}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6042ms
400Bad Request482ms
401Unauthorized841ms
Plugins 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
id3 / 3
#validinvalidschema
1255493{
2255493 "format": "uuid",
3255493 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
42647n/a "type": "string"
5255493}
enabled1 / 1
194170{
294170 "type": "boolean"
394170}
name1 / 1
11011n/a{
21011n/a "type": "string"
31011n/a}
version1 / 1
1964n/a{
2964n/a "type": "string"
3964n/a}
title1 / 1
1981n/a{
2981n/a "type": "string"
3981n/a}
description1 / 1
11084n/a{
21084n/a "type": "string"
31084n/a}
Responses
codedescriptionhitsavg
20018432ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request9902ms
401Unauthorized1551ms
500Internal Server Error82ms
Query Parameters
id3 / 3
#validinvalidschema
113966{
213966 "format": "uuid",
313966 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4205n/a "type": "string"
513966}
enabled1 / 1
117845{
217845 "type": "boolean"
317845}
name1 / 1
1164n/a{
2164n/a "type": "string"
3164n/a}
title1 / 1
1181n/a{
2181n/a "type": "string"
3181n/a}
description1 / 1
1213n/a{
2213n/a "type": "string"
3213n/a}
type2 / 2
WorkflowType
115745{
215745 "enum": [
3157n/a "AssetV1"
415745 ],
5202n/a "type": "string"
615745}
trigger2 / 2
WorkflowTrigger
116250{
216250 "enum": [
399n/a "AssetCreate",
424n/a "AssetMetadataExtraction",
539n/a "AssetTagged"
616250 ],
7212n/a "type": "string"
816250}
pluginName1 / 1
1178n/a{
2178n/a "type": "string"
3178n/a}
pluginVersion1 / 1
1170n/a{
2170n/a "type": "string"
3170n/a}
Responses
codedescriptionhitsavg
2002942ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2481ms
500Internal Server Error103ms
401Unauthorized921ms
Responses
codedescriptionhitsavg
2001951ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3171ms
Path Parameters
id3 / 3
#validinvalidschema
157529{
257529 "format": "uuid",
357529 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4604n/a "type": "string"
557529}
Responses
codedescriptionhitsavg
2004432ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1021ms
400Bad Request592ms
Queues 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
20033572ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized6011ms
Path Parameters
name2 / 2
QueueName
#validinvalidschema
1494154{
2494154 "enum": [
39n/a "thumbnailGeneration",
417n/a "metadataExtraction",
58n/a "videoConversion",
620n/a "faceDetection",
714n/a "facialRecognition",
821n/a "smartSearch",
922n/a "duplicateDetection",
1017n/a "backgroundTask",
1114n/a "storageTemplateMigration",
1217n/a "migration",
1315n/a "search",
1411n/a "sidecar",
1532n/a "library",
1623n/a "notifications",
1716n/a "backupDatabase",
18192n/a "ocr",
1918n/a "workflow",
2010n/a "integrityCheck",
2118n/a "editor"
22494154 ],
23648n/a "type": "string"
24494154}
Responses
codedescriptionhitsavg
2003052ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1891ms
400Bad Request1542ms
Path Parameters
name2 / 2
QueueName
#validinvalidschema
162768{
262768 "enum": [
338n/a "thumbnailGeneration",
427n/a "metadataExtraction",
550n/a "videoConversion",
629n/a "faceDetection",
717n/a "facialRecognition",
826n/a "smartSearch",
915n/a "duplicateDetection",
1026n/a "backgroundTask",
1112n/a "storageTemplateMigration",
1226n/a "migration",
1316n/a "search",
1410n/a "sidecar",
1527n/a "library",
1622n/a "notifications",
1734n/a "backupDatabase",
18181n/a "ocr",
1924n/a "workflow",
2017n/a "integrityCheck",
2130n/a "editor"
2262768 ],
23695n/a "type": "string"
2462768}
Body
application/json3 / 3
QueueUpdateDto
155391{
227973 "properties": {
327973 "isPaused": {
427973 "type": "boolean"
527973 }
627973 },
762618 "type": "object"
855391}
Responses
codedescriptionhitsavg
2004262ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized721ms
400Bad Request1971ms
Path Parameters
name2 / 2
QueueName
#validinvalidschema
170038{
270038 "enum": [
314n/a "thumbnailGeneration",
420n/a "metadataExtraction",
513n/a "videoConversion",
634n/a "faceDetection",
719n/a "facialRecognition",
828n/a "smartSearch",
932n/a "duplicateDetection",
1023n/a "backgroundTask",
118n/a "storageTemplateMigration",
1224n/a "migration",
1342n/a "search",
1412n/a "sidecar",
1565n/a "library",
1633n/a "notifications",
1717n/a "backupDatabase",
18262n/a "ocr",
1923n/a "workflow",
2020n/a "integrityCheck",
2111n/a "editor"
2270038 ],
23738n/a "type": "string"
2470038}
Body
application/json3 / 3
QueueDeleteDto
161062{
226944 "properties": {
326944 "failed": {
426944 "type": "boolean",
526944 }
626944 },
765418 "type": "object"
861062}
Responses
codedescriptionhitsavg
2045392ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized401ms
400Bad Request1591ms
Path Parameters
name2 / 2
QueueName
#validinvalidschema
1533208{
2533208 "enum": [
340n/a "thumbnailGeneration",
410n/a "metadataExtraction",
535n/a "videoConversion",
634n/a "faceDetection",
716n/a "facialRecognition",
820n/a "smartSearch",
919n/a "duplicateDetection",
1031n/a "backgroundTask",
1112n/a "storageTemplateMigration",
1217n/a "migration",
1312n/a "search",
1424n/a "sidecar",
1534n/a "library",
1615n/a "notifications",
1758n/a "backupDatabase",
1890n/a "ocr",
1926n/a "workflow",
2023n/a "integrityCheck",
2117n/a "editor"
22533208 ],
23741n/a "type": "string"
24533208}
Query Parameters
status4 / 4
1199209{
2199209 "items": {
4199209 },
5408n/a "type": "array"
6199209}
Referenced Components (1)3 of 3 keywords
QueueJobStatus3 of 3 keywords
1791998{
2791998 "enum": [
3205n/a "active",
4107n/a "failed",
5137n/a "completed",
6124n/a "delayed",
7111n/a "waiting",
8107n/a "paused"
9791998 ],
101789n/a "type": "string"
11791998}
Responses
codedescriptionhitsavg
2003372ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3662ms
401Unauthorized381ms
Server 14 operations 14 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
2001461ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3651ms
Responses
codedescriptionhitsavg
20083ms
Responses
codedescriptionhitsavg
20083ms
Responses
codedescriptionhitsavg
2041621ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3491ms
Responses
codedescriptionhitsavg
2000never seen
4041721ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3341ms
Body
application/json6 / 6
LicenseKeyDto
#validinvalidschema
116179{
218151 "properties": {
321021 "activationKey": {
421021 "type": "string"
521021 },
616746 "licenseKey": {
716724 "pattern": "^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$",
819122 "type": "string"
916746 }
1018151 },
1121220 "required": [
1221319 "licenseKey",
132311 "activationKey"
1421220 ],
152328 "type": "object"
1616179}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4971ms
401Unauthorized291ms
Responses
codedescriptionhitsavg
20081ms
Responses
codedescriptionhitsavg
20081ms
Responses
codedescriptionhitsavg
2001712ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3391ms
Responses
codedescriptionhitsavg
2001721ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3391ms
Responses
codedescriptionhitsavg
20081ms
Responses
codedescriptionhitsavg
2001641ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3471ms
Responses
codedescriptionhitsavg
20081ms
Sessions 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
2041592ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3501ms
Responses
codedescriptionhitsavg
2001663ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3451ms
Body
application/json7 / 7
SessionCreateDto
#validinvalidschema
13836236{
22427195 "properties": {
3179167 "deviceOS": {
4179167 "type": "string"
5179167 },
6175066 "deviceType": {
7175066 "type": "string"
8175066 },
91712150 "duration": {
10175653 "maximum": 9007199254740991,
11176544 "minimum": 1,
12180854 "type": "integer"
131712150 }
142427195 },
15403141 "type": "object"
163836236}
Responses
codedescriptionhitsavg
20133184ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1351ms
400Bad Request3291ms
500Internal Server Error3832ms
Path Parameters
id3 / 3
#validinvalidschema
163129{
263129 "format": "uuid",
363129 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4660n/a "type": "string"
563129}
Responses
codedescriptionhitsavg
2041023ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4721ms
401Unauthorized861ms
Path Parameters
id3 / 3
#validinvalidschema
162517{
262517 "format": "uuid",
362517 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4642n/a "type": "string"
562517}
Body
application/json3 / 3
SessionUpdateDto
157049{
217930 "properties": {
317930 "isPendingSyncReset": {
417930 "type": "boolean"
517930 }
617930 },
760019 "type": "object"
857049}
Responses
codedescriptionhitsavg
200523ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5562ms
401Unauthorized341ms
Path Parameters
id3 / 3
#validinvalidschema
157731{
257731 "format": "uuid",
357731 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4608n/a "type": "string"
557731}
Responses
codedescriptionhitsavg
204783ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4601ms
401Unauthorized701ms
Stacks 7 operations 7 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json7 / 7
BulkIdsDto
#validinvalidschema
1313158{
231372 "properties": {
331372 "ids": {
431317 "items": {
55323 "format": "uuid",
65323 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
77632 "type": "string"
831317 },
933055 "type": "array"
1031372 }
1131372 },
1238568 "required": [
1338568 "ids"
1438568 ],
1545318 "type": "object"
16313158}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2662ms
400Bad Request2301ms
401Unauthorized291ms
Query Parameters
primaryAssetId3 / 3
#validinvalidschema
1117125{
2117125 "format": "uuid",
3117125 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4242n/a "type": "string"
5117125}
Responses
codedescriptionhitsavg
2001642ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2271ms
400Bad Request1251ms
Body
application/json8 / 8
StackCreateDto
#validinvalidschema
1260108{
226075 "properties": {
326075 "assetIds": {
426136 "items": {
567486 "format": "uuid",
667486 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
7760195 "type": "string"
826136 },
92961 "minItems": 2,
1029738 "type": "array"
1126075 }
1226075 },
1333520 "required": [
1433520 "assetIds"
1533520 ],
1635513 "type": "object"
17260108}
Responses
codedescriptionhitsavg
2010never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request7521ms
401Unauthorized151ms
Path Parameters
id3 / 3
#validinvalidschema
1374137{
2374137 "format": "uuid",
3374137 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5374137}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4702ms
401Unauthorized411ms
Path Parameters
id3 / 3
#validinvalidschema
1389122{
2389122 "format": "uuid",
3389122 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4511n/a "type": "string"
5389122}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4742ms
401Unauthorized371ms
Path Parameters
id3 / 3
#validinvalidschema
1412113{
2412113 "format": "uuid",
3412113 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4525n/a "type": "string"
5412113}
Body
application/json5 / 5
StackUpdateDto
142554{
24325 "properties": {
34325 "primaryAssetId": {
44315 "format": "uuid",
54315 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
65810 "type": "string"
74325 }
84325 },
945029 "type": "object"
1042554}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5142ms
401Unauthorized111ms
Path Parameters
id3 / 3
#validinvalidschema
1356161{
2356161 "format": "uuid",
3356161 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4517n/a "type": "string"
5356161}
assetId3 / 3
1358159{
2358159 "format": "uuid",
3358159 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4517n/a "type": "string"
5358159}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4982ms
401Unauthorized191ms
Sync 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json6 / 6
SyncAckDeleteDto
#validinvalidschema
147979{
227166 "properties": {
327166 "types": {
427155 "items": {
627155 },
732611 "type": "array"
827166 }
927166 },
1054513 "type": "object"
1147979}
Referenced Components (1)3 of 3 keywords
SyncEntityType3 of 3 keywords
1173379{
2173379 "enum": [
335n/a "AuthUserV1",
411n/a "AuthUserV2",
5254n/a "UserV1",
64n/a "UserDeleteV1",
718n/a "AssetV1",
828n/a "AssetV2",
913n/a "AssetDeleteV1",
1055n/a "AssetExifV1",
1194n/a "AssetEditV1",
1212n/a "AssetEditDeleteV1",
1310n/a "AssetMetadataV1",
1439n/a "AssetMetadataDeleteV1",
1550n/a "AssetOcrV1",
1696n/a "AssetOcrDeleteV1",
1717n/a "PartnerV1",
188n/a "PartnerDeleteV1",
1957n/a "PartnerAssetV1",
209n/a "PartnerAssetV2",
214n/a "PartnerAssetBackfillV1",
229n/a "PartnerAssetBackfillV2",
2350n/a "PartnerAssetDeleteV1",
245n/a "PartnerAssetExifV1",
2553n/a "PartnerAssetExifBackfillV1",
2652n/a "PartnerStackBackfillV1",
274n/a "PartnerStackDeleteV1",
2851n/a "PartnerStackV1",
2912n/a "AlbumV1",
3015n/a "AlbumV2",
316n/a "AlbumDeleteV1",
3215n/a "AlbumUserV1",
334n/a "AlbumUserBackfillV1",
3418n/a "AlbumUserDeleteV1",
3512n/a "AlbumAssetCreateV1",
363n/a "AlbumAssetCreateV2",
376n/a "AlbumAssetUpdateV1",
3858n/a "AlbumAssetUpdateV2",
393n/a "AlbumAssetBackfillV1",
405n/a "AlbumAssetBackfillV2",
4137n/a "AlbumAssetExifCreateV1",
4252n/a "AlbumAssetExifUpdateV1",
4343n/a "AlbumAssetExifBackfillV1",
446n/a "AlbumToAssetV1",
458n/a "AlbumToAssetDeleteV1",
4611n/a "AlbumToAssetBackfillV1",
478n/a "MemoryV1",
4812n/a "MemoryV2",
497n/a "MemoryDeleteV1",
5016n/a "MemoryToAssetV1",
5150n/a "MemoryToAssetV2",
5250n/a "MemoryToAssetDeleteV1",
5315n/a "StackV1",
5453n/a "StackDeleteV1",
5516n/a "PersonV1",
567n/a "PersonDeleteV1",
5712n/a "AssetFaceV1",
584n/a "AssetFaceV2",
598n/a "AssetFaceV3",
6012n/a "AssetFaceDeleteV1",
613n/a "UserMetadataV1",
6245n/a "UserMetadataDeleteV1",
638n/a "SyncAckV1",
6443n/a "SyncResetV1",
6512n/a "SyncCompleteV1"
66173379 ],
6718075 "type": "string"
68173379}
Responses
codedescriptionhitsavg
2043941ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error302ms
400Bad Request1121ms
401Unauthorized551ms
Responses
codedescriptionhitsavg
2001601ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3511ms
Body
application/json6 / 6
SyncAckSetDto
#validinvalidschema
1367161{
236714 "properties": {
336714 "acks": {
43679 "items": {
53687532 "type": "string"
63679 },
73751 "maxItems": 1000,
83765 "type": "array"
936714 }
1036714 },
11381142 "required": [
12381142 "acks"
13381142 ],
145235 "type": "object"
15367161}
Responses
codedescriptionhitsavg
2040never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error812ms
400Bad Request3721ms
401Unauthorized1041ms
Body
application/json8 / 8
SyncStreamDto
#validinvalidschema
14022{
24116 "properties": {
3515 "reset": {
4515 "type": "boolean"
5515 },
64511 "types": {
7456 "items": {
9456 },
10515 "type": "array"
114511 }
124116 },
13561 "required": [
14561 "types"
15561 ],
16575 "type": "object"
174022}
Referenced Components (1)3 of 3 keywords
SyncRequestType3 of 3 keywords
1316{
2316 "enum": [
31n/a "AlbumsV1",
41n/a "AlbumsV2",
51n/a "AlbumUsersV1",
61n/a "AlbumToAssetsV1",
71n/a "AlbumAssetsV1",
81n/a "AlbumAssetsV2",
91n/a "AlbumAssetExifsV1",
101n/a "AssetsV1",
111n/a "AssetsV2",
121n/a "AssetExifsV1",
131n/a "AssetEditsV1",
141n/a "AssetMetadataV1",
151n/a "AssetOcrV1",
161n/a "AuthUsersV1",
171n/a "AuthUsersV2",
181n/a "MemoriesV1",
191n/a "MemoriesV2",
201n/a "MemoryToAssetsV1",
211n/a "MemoryToAssetsV2",
221n/a "PartnersV1",
231n/a "PartnerAssetsV1",
241n/a "PartnerAssetsV2",
251n/a "PartnerAssetExifsV1",
261n/a "PartnerStacksV1",
271n/a "StacksV1",
281n/a "UsersV1",
291n/a "PeopleV1",
301n/a "AssetFacesV1",
311n/a "AssetFacesV2",
321n/a "AssetFacesV3",
331n/a "UserMetadataV1"
34316 ],
35325 "type": "string"
36316}
Responses
codedescriptionhitsavg
200323ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized41ms
400Bad Request291ms
System config 4 operations 3 covered 1 partial 0 uncovered 0 not measured 99% #
Responses
codedescriptionhitsavg
2001573ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3531ms
Body
application/json397 / 400
AdminConfigDto
#validinvalidschema
12011395{
22231367 "properties": {
3155732 "backup": {
5155732 },
61379210 "ffmpeg": {
81379210 },
91463126 "image": {
111463126 },
12151178 "integrityChecks": {
14151178 },
151353236 "job": {
171353236 },
18155435 "library": {
20155435 },
21157118 "logging": {
23157118 },
241411178 "machineLearning": {
261411178 },
27156425 "map": {
29156425 },
30157217 "metadata": {
32157217 },
33157118 "newVersionCheck": {
35157118 },
36154643 "nightlyTasks": {
38154643 },
39151277 "notifications": {
41151277 },
421447142 "oauth": {
441447142 },
4515845 "passwordLogin": {
4715845 },
48157811 "reverseGeocoding": {
50157811 },
51156425 "server": {
53156425 },
54156623 "storageTemplate": {
56156623 },
57156029 "templates": {
59156029 },
60157811 "theme": {
62157811 },
63156920 "trash": {
65156920 },
66157514 "user": {
68157514 }
692231367 },
70156823 "required": [
7115892 "backup",
7215892 "ffmpeg",
7315892 "integrityChecks",
7415892 "job",
7515892 "logging",
7615892 "machineLearning",
7715892 "map",
7815892 "reverseGeocoding",
7915892 "metadata",
8015892 "oauth",
8115892 "passwordLogin",
8215892 "storageTemplate",
8315892 "image",
8415892 "newVersionCheck",
8515892 "nightlyTasks",
8615892 "trash",
8715892 "theme",
8815892 "library",
8915892 "notifications",
9015892 "templates",
9115892 "server",
9215892 "user"
93156823 ],
9415915 "type": "object"
952011395}
Referenced Components (53)463 of 468 keywords
AdminConfigBackupsDto6 of 6 keywords
1155732{
2155726 "properties": {
3155726 "database": {
5155726 }
6155726 },
715831 "required": [
815831 "database"
915831 ],
1015845 "type": "object"
11155732}
AdminConfigClipDto7 of 7 keywords
1156617{
2156810 "properties": {
315725 "enabled": {
415725 "type": "boolean"
515725 },
615725 "modelName": {
715725 "type": "string"
815725 }
9156810 },
1015762 "required": [
1115771 "enabled",
1215771 "modelName"
1315762 ],
1415785 "type": "object"
15156617}
AdminConfigDatabaseBackupDto10 of 10 keywords
1155726{
2156018 "properties": {
315725 "cronExpression": {
415725 "type": "string"
515725 },
615725 "enabled": {
715725 "type": "boolean"
815725 },
915698 "keepLastAmount": {
1015711 "maximum": 9007199254740991,
1115702 "minimum": 1,
1215716 "type": "integer"
1315698 }
14156018 },
1515753 "required": [
1615771 "enabled",
1715771 "cronExpression",
1815771 "keepLastAmount"
1915753 ],
2015785 "type": "object"
21155726}
AdminConfigDuplicateDetectionDto10 of 10 keywords
1156419{
2156612 "properties": {
315725 "enabled": {
415725 "type": "boolean"
515725 },
615707 "maxDistance": {
715725 "format": "double",
815711 "maximum": 0.1,
915711 "minimum": 0.001,
1015725 "type": "number"
1115707 }
12156612 },
1315762 "required": [
1415771 "enabled",
1515771 "maxDistance"
1615762 ],
1715785 "type": "object"
18156419}
AdminConfigFFmpegDto40 of 40 keywords
11379210{
21403181 "properties": {
315776 "accel": {
515776 },
615785 "accelDecode": {
715785 "type": "boolean"
815785 },
9157211 "acceptedAudioCodecs": {
1015726 "items": {
1215726 },
1315785 "type": "array"
14157211 },
15157211 "acceptedContainers": {
1615726 "items": {
1815726 },
1915785 "type": "array"
20157211 },
21157211 "acceptedVideoCodecs": {
2215726 "items": {
2415726 },
2515785 "type": "array"
26157211 },
2715758 "bframes": {
2815771 "maximum": 16,
2915771 "minimum": -1,
3015776 "type": "integer"
3115758 },
3215776 "cqMode": {
3315776 "$ref": "#/components/schemas/CQMode"
3415776 },
3515738 "crf": {
3615751 "maximum": 51,
3715751 "minimum": 0,
3815756 "type": "integer"
3915738 },
4015758 "gopSize": {
4115771 "maximum": 9007199254740991,
4215771 "minimum": 0,
4315776 "type": "integer"
4415758 },
4515785 "maxBitrate": {
4615785 "type": "string"
4715785 },
4815785 "preferredHwDevice": {
4915785 "type": "string"
5015785 },
5115785 "preset": {
5215785 "type": "string"
5315785 },
54154637 "realtime": {
56154637 },
5715758 "refs": {
5815771 "maximum": 6,
5915771 "minimum": 0,
6015776 "type": "integer"
6115758 },
6215776 "targetAudioCodec": {
6415776 },
6515785 "targetResolution": {
6615785 "type": "string"
6715785 },
6815776 "targetVideoCodec": {
7015776 },
7115785 "temporalAQ": {
7215785 "type": "boolean"
7315785 },
7415758 "threads": {
7515771 "maximum": 9007199254740991,
7615771 "minimum": 0,
7715776 "type": "integer"
7815758 },
7915776 "tonemap": {
8115776 },
8215776 "transcode": {
8415776 },
8515785 "twoPass": {
8615785 "type": "boolean"
8715785 }
881403181 },
89156024 "required": [
9015813 "crf",
9115831 "threads",
9215831 "preset",
9315831 "targetVideoCodec",
9415831 "acceptedVideoCodecs",
9515831 "targetAudioCodec",
9615831 "acceptedAudioCodecs",
9715831 "acceptedContainers",
9815831 "targetResolution",
9915831 "maxBitrate",
10015831 "bframes",
10115831 "refs",
10215831 "gopSize",
10315831 "temporalAQ",
10415831 "cqMode",
10515831 "twoPass",
10615831 "preferredHwDevice",
10715831 "transcode",
10815831 "accel",
10915831 "accelDecode",
11015831 "tonemap",
11115831 "realtime"
112156024 ],
11315845 "type": "object"
1141379210}
AdminConfigFFmpegRealtimeDto10 of 10 keywords
1154637{
2154929 "properties": {
315725 "enabled": {
415725 "type": "boolean"
515725 },
6156512 "resolutions": {
715657 "items": {
915657 },
1015725 "type": "array"
11156512 },
12156512 "videoCodecs": {
1315657 "items": {
1515657 },
1615725 "type": "array"
17156512 }
18154929 },
1915753 "required": [
2015771 "enabled",
2115771 "videoCodecs",
2215771 "resolutions"
2315753 ],
2415785 "type": "object"
25154637}
AdminConfigFacesDto6 of 6 keywords
1157211{
215725 "properties": {
315725 "import": {
415725 "type": "boolean"
515725 }
615725 },
715771 "required": [
815771 "import"
915771 ],
1015785 "type": "object"
11157211}
AdminConfigFacialRecognitionDto18 of 18 keywords
1154043{
2154632 "properties": {
315725 "enabled": {
415725 "type": "boolean"
515725 },
615707 "maxDistance": {
715725 "format": "double",
815711 "maximum": 2,
915711 "minimum": 0.1,
1015725 "type": "number"
1115707 },
1215698 "minFaces": {
1315711 "maximum": 9007199254740991,
1415702 "minimum": 1,
1515716 "type": "integer"
1615698 },
1715697 "minScore": {
1815715 "format": "double",
1915701 "maximum": 1,
2015701 "minimum": 0.1,
2115715 "type": "number"
2215697 },
2315725 "modelName": {
2415725 "type": "string"
2515725 }
26154632 },
2715726 "required": [
2815771 "enabled",
2915771 "modelName",
3015762 "minScore",
3115771 "maxDistance",
3215771 "minFaces"
3315726 ],
3415785 "type": "object"
35154043}
AdminConfigGeneratedFullsizeImageDto11 of 11 keywords
1154832{
2155124 "properties": {
315695 "enabled": {
415695 "type": "boolean"
515695 },
615686 "format": {
815686 },
914435 "progressive": {
1014435 "type": "boolean"
1114435 },
1215668 "quality": {
1315681 "maximum": 100,
1415672 "minimum": 1,
1515686 "type": "integer"
1615668 }
17155124 },
1815723 "required": [
1915741 "enabled",
2015741 "format",
2115741 "quality"
2215723 ],
2315755 "type": "object"
24154832}
AdminConfigGeneratedImageDto13 of 13 keywords
1309670{
2310254 "properties": {
3314212 "format": {
5314212 },
6289010 "progressive": {
7289010 "type": "boolean"
8289010 },
9313816 "quality": {
1031422 "maximum": 100,
1131404 "minimum": 1,
12314212 "type": "integer"
13313816 },
14313816 "size": {
1531422 "maximum": 9007199254740991,
1631404 "minimum": 1,
17314212 "type": "integer"
18313816 }
19310254 },
2031506 "required": [
2131542 "format",
2231542 "quality",
2331542 "size"
2431506 ],
25315610 "type": "object"
26309670}
AdminConfigImageDto10 of 10 keywords
11463126{
21471113 "properties": {
315776 "colorspace": {
515776 },
615785 "extractEmbedded": {
715785 "type": "boolean"
815785 },
9154832 "fullsize": {
11154832 },
12154835 "preview": {
14154835 },
15154835 "thumbnail": {
17154835 }
181471113 },
1915768 "required": [
2015831 "thumbnail",
2115831 "preview",
2215804 "fullsize",
2315831 "colorspace",
2415831 "extractEmbedded"
2515768 ],
2615845 "type": "object"
271463126}
AdminConfigIntegrityChecksDto8 of 8 keywords
1151178{
2151470 "properties": {
3154736 "checksumFiles": {
5154736 },
6156617 "missingFiles": {
8156617 },
9156617 "untrackedFiles": {
11156617 }
12151470 },
1315813 "required": [
1415831 "missingFiles",
1515831 "untrackedFiles",
1615831 "checksumFiles"
1715813 ],
1815845 "type": "object"
19151178}
AdminConfigIntegrityChecksumJobDto14 of 14 keywords
1154736{
2155127 "properties": {
315725 "cronExpression": {
415725 "type": "string"
515725 },
615725 "enabled": {
715725 "type": "boolean"
815725 },
915689 "percentageLimit": {
1015725 "format": "double",
1115711 "maximum": 1,
1215693 "minimum": 0,
1315725 "type": "number"
1415689 },
1515698 "timeLimit": {
1615711 "maximum": 9007199254740991,
1715711 "minimum": 0,
1815716 "type": "integer"
1915698 }
20155127 },
2115744 "required": [
2215771 "enabled",
2315771 "cronExpression",
2415771 "timeLimit",
2515771 "percentageLimit"
2615744 ],
2715785 "type": "object"
28154736}
AdminConfigIntegrityJobDto7 of 7 keywords
1313234{
2313620 "properties": {
3314410 "cronExpression": {
4314410 "type": "string"
5314410 },
6314410 "enabled": {
7314410 "type": "boolean"
8314410 }
9313620 },
1031524 "required": [
1131542 "enabled",
1231542 "cronExpression"
1331524 ],
14315610 "type": "object"
15313234}
AdminConfigJobDto20 of 20 keywords
11353236{
21368216 "properties": {
3156914 "backgroundTask": {
5156914 },
6156914 "editor": {
8156914 },
9156914 "faceDetection": {
11156914 },
12156716 "integrityCheck": {
14156716 },
15156914 "library": {
17156914 },
18156716 "metadataExtraction": {
20156716 },
21156716 "migration": {
23156716 },
24156716 "notifications": {
26156716 },
27156716 "ocr": {
29156716 },
30156716 "search": {
32156716 },
33156815 "sidecar": {
35156815 },
36156914 "smartSearch": {
38156914 },
39156914 "thumbnailGeneration": {
41156914 },
42156914 "videoConversion": {
44156914 },
45156617 "workflow": {
47156617 }
481368216 },
49156915 "required": [
5015831 "thumbnailGeneration",
5115831 "metadataExtraction",
5215831 "videoConversion",
5315831 "faceDetection",
5415831 "smartSearch",
5515831 "backgroundTask",
5615831 "migration",
5715831 "search",
5815831 "sidecar",
5915831 "library",
6015831 "notifications",
6115831 "ocr",
6215831 "workflow",
6315831 "editor",
6415831 "integrityCheck"
65156915 ],
6615845 "type": "object"
671353236}
AdminConfigJobSettingsDto8 of 8 keywords
123519226{
223519136 "properties": {
323519136 "concurrency": {
42356416 "maximum": 9007199254740991,
52353545 "minimum": 1,
62356590 "type": "integer"
723519136 }
823519136 },
92365515 "required": [
102365515 "concurrency"
112365515 ],
122367075 "type": "object"
1323519226}
AdminConfigLibraryDto7 of 7 keywords
1155435{
2155628 "properties": {
3156617 "scan": {
5156617 },
6157211 "watch": {
8157211 }
9155628 },
1015822 "required": [
1115831 "scan",
1215831 "watch"
1315822 ],
1415845 "type": "object"
15155435}
AdminConfigLibraryScanDto7 of 7 keywords
1156617{
2156810 "properties": {
315725 "cronExpression": {
415725 "type": "string"
515725 },
615725 "enabled": {
715725 "type": "boolean"
815725 }
9156810 },
1015762 "required": [
1115771 "enabled",
1215771 "cronExpression"
1315762 ],
1415785 "type": "object"
15156617}
AdminConfigLibraryWatchDto6 of 6 keywords
1157211{
215725 "properties": {
315725 "enabled": {
415725 "type": "boolean"
515725 }
615725 },
715771 "required": [
815771 "enabled"
915771 ],
1015785 "type": "object"
11157211}
AdminConfigLoggingDto7 of 7 keywords
1157118{
2157311 "properties": {
315785 "enabled": {
415785 "type": "boolean"
515785 },
615776 "level": {
815776 }
9157311 },
1015822 "required": [
1115831 "enabled",
1215831 "level"
1315822 ],
1415845 "type": "object"
15157118}
AdminConfigMachineLearningAvailabilityChecksDto12 of 12 keywords
1155429{
2155721 "properties": {
315725 "enabled": {
415725 "type": "boolean"
515725 },
615698 "interval": {
715711 "maximum": 9007199254740991,
815711 "minimum": -9007199254740991,
915716 "type": "integer"
1015698 },
1115698 "timeout": {
1215711 "maximum": 9007199254740991,
1315711 "minimum": -9007199254740991,
1415716 "type": "integer"
1515698 }
16155721 },
1715753 "required": [
1815771 "enabled",
1915771 "timeout",
2015771 "interval"
2115753 ],
2215785 "type": "object"
23155429}
AdminConfigMachineLearningDto14 of 14 keywords
11411178{
21418166 "properties": {
3155429 "availabilityChecks": {
5155429 },
6156617 "clip": {
8156617 },
9156419 "duplicateDetection": {
11156419 },
1215785 "enabled": {
1315785 "type": "boolean"
1415785 },
15154043 "facialRecognition": {
17154043 },
18154142 "ocr": {
20154142 },
21157211 "urls": {
2215735 "items": {
2320365 "type": "string"
2415735 },
2515771 "minItems": 1,
2615785 "type": "array"
27157211 }
281418166 },
2915777 "required": [
3015831 "enabled",
3115831 "urls",
3215831 "availabilityChecks",
3315831 "clip",
3415831 "duplicateDetection",
3515831 "facialRecognition",
3615831 "ocr"
3715777 ],
3815845 "type": "object"
391411178}
AdminConfigMapDto10 of 10 keywords
1156425{
2156717 "properties": {
315776 "darkStyle": {
415771 "format": "uri",
515785 "type": "string"
615776 },
715785 "enabled": {
815785 "type": "boolean"
915785 },
1015776 "lightStyle": {
1115771 "format": "uri",
1215785 "type": "string"
1315776 }
14156717 },
1515813 "required": [
1615831 "enabled",
1715831 "lightStyle",
1815831 "darkStyle"
1915813 ],
2015845 "type": "object"
21156425}
AdminConfigMetadataDto6 of 6 keywords
1157217{
2157211 "properties": {
3157211 "faces": {
5157211 }
6157211 },
715831 "required": [
815831 "faces"
915831 ],
1015845 "type": "object"
11157217}
AdminConfigNewVersionCheckDto7 of 7 keywords
1157118{
2157311 "properties": {
315776 "channel": {
515776 },
615785 "enabled": {
715785 "type": "boolean"
815785 }
9157311 },
1015822 "required": [
1115831 "enabled",
1215831 "channel"
1315822 ],
1415845 "type": "object"
15157118}
AdminConfigNightlyTasksDto12 of 12 keywords
1154643{
2155232 "properties": {
315785 "clusterNewFaces": {
415785 "type": "boolean"
515785 },
615785 "databaseCleanup": {
715785 "type": "boolean"
815785 },
915785 "generateMemories": {
1015785 "type": "boolean"
1115785 },
1215785 "missingThumbnails": {
1315785 "type": "boolean"
1415785 },
1515776 "startTime": {
1615771 "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
1715785 "type": "string"
1815776 },
1915776 "syncQuotaUsage": {
2015776 "type": "boolean"
2115776 }
22155232 },
2315786 "required": [
2415831 "startTime",
2515831 "databaseCleanup",
2615831 "missingThumbnails",
2715831 "clusterNewFaces",
2815831 "generateMemories",
2915831 "syncQuotaUsage"
3015786 ],
3115845 "type": "object"
32154643}
AdminConfigNotificationsDto6 of 6 keywords
1151277{
2151271 "properties": {
3151271 "smtp": {
5151271 }
6151271 },
715831 "required": [
815831 "smtp"
915831 ],
1015845 "type": "object"
11151277}
AdminConfigOAuthDto32 of 32 keywords
11447142{
21468116 "properties": {
314505 "accountManagementUrl": {
414505 "type": "string"
514505 },
615785 "allowInsecureRequests": {
715785 "type": "boolean"
815785 },
915785 "autoLaunch": {
1015785 "type": "boolean"
1115785 },
1215785 "autoRegister": {
1315785 "type": "boolean"
1415785 },
1515785 "buttonText": {
1615785 "type": "string"
1715785 },
1815785 "clientId": {
1915785 "type": "string"
2015785 },
2115785 "clientSecret": {
2215785 "type": "string"
2315785 },
2415767 "defaultStorageQuota": {
2515521 "maximum": 9007199254740991,
2615521 "minimum": 0,
271583n/a "nullable": true,
2815785 "type": "integer"
2915767 },
3015785 "enabled": {
3115785 "type": "boolean"
3215785 },
3315785 "endSessionEndpoint": {
3415785 "type": "string"
3515785 },
3615785 "issuerUrl": {
3715785 "type": "string"
3815785 },
3915785 "mobileOverrideEnabled": {
4015785 "type": "boolean"
4115785 },
4215785 "mobileRedirectUri": {
4315785 "type": "string"
4415785 },
4515785 "profileSigningAlgorithm": {
4615785 "type": "string"
4715785 },
4815785 "prompt": {
4915785 "type": "string"
5015785 },
5115785 "roleClaim": {
5215785 "type": "string"
5315785 },
5415785 "scope": {
5515785 "type": "string"
5615785 },
5715785 "signingAlgorithm": {
5815785 "type": "string"
5915785 },
6015785 "storageLabelClaim": {
6115785 "type": "string"
6215785 },
6315785 "storageQuotaClaim": {
6415785 "type": "string"
6515785 },
6615758 "timeout": {
6715771 "maximum": 9007199254740991,
6815762 "minimum": 1,
6915776 "type": "integer"
7015758 },
7115776 "tokenEndpointAuthMethod": {
7315776 }
741468116 },
75156321 "required": [
7615831 "autoLaunch",
7715831 "autoRegister",
7815831 "buttonText",
7915831 "clientId",
8015831 "clientSecret",
8115831 "tokenEndpointAuthMethod",
8215831 "timeout",
8315831 "allowInsecureRequests",
8415831 "defaultStorageQuota",
8515831 "enabled",
8615831 "issuerUrl",
8715831 "scope",
8815831 "prompt",
8915831 "endSessionEndpoint",
9015831 "signingAlgorithm",
9115831 "profileSigningAlgorithm",
9215831 "storageLabelClaim",
9315831 "storageQuotaClaim",
9415831 "roleClaim",
9515831 "mobileOverrideEnabled",
9615831 "mobileRedirectUri"
97156321 ],
9815845 "type": "object"
991447142}
AdminConfigOcrDto18 of 18 keywords
1154142{
2154632 "properties": {
315725 "enabled": {
415725 "type": "boolean"
515725 },
615698 "maxResolution": {
715711 "maximum": 9007199254740991,
815702 "minimum": 1,
915716 "type": "integer"
1015698 },
1115707 "minDetectionScore": {
1215725 "format": "double",
1315711 "maximum": 1,
1415711 "minimum": 0.1,
1515725 "type": "number"
1615707 },
1715707 "minRecognitionScore": {
1815725 "format": "double",
1915711 "maximum": 1,
2015711 "minimum": 0.1,
2115725 "type": "number"
2215707 },
2315725 "modelName": {
2415725 "type": "string"
2515725 }
26154632 },
2715735 "required": [
2815771 "enabled",
2915771 "modelName",
3015771 "maxResolution",
3115771 "minDetectionScore",
3215771 "minRecognitionScore"
3315735 ],
3415785 "type": "object"
35154142}
AdminConfigPasswordLoginDto1 of 6 keywords
115845{
215840 "properties": {
315840 "enabled": {
415840 "type": "boolean"
515840 }
615840 },
715840 "required": [
815840 "enabled"
915840 ],
1015845 "type": "object"
1115845}
AdminConfigReverseGeocodingDto6 of 6 keywords
1157811{
215785 "properties": {
315785 "enabled": {
415785 "type": "boolean"
515785 }
615785 },
715831 "required": [
815831 "enabled"
915831 ],
1015845 "type": "object"
11157811}
AdminConfigServerDto8 of 8 keywords
1156425{
2156915 "properties": {
315765 "externalDomain": {
415765 "type": "string"
515765 },
615785 "loginPageMessage": {
715785 "type": "string"
815785 },
915785 "publicUsers": {
1015785 "type": "boolean"
1115785 }
12156915 },
1315795 "required": [
1415813 "externalDomain",
1515831 "loginPageMessage",
1615831 "publicUsers"
1715795 ],
1815845 "type": "object"
19156425}
AdminConfigSmtpDto9 of 9 keywords
1151271{
2151662 "properties": {
315725 "enabled": {
415725 "type": "boolean"
515725 },
615725 "from": {
715725 "type": "string"
815725 },
915725 "replyTo": {
1015725 "type": "string"
1115725 },
12153047 "transport": {
14153047 }
15151662 },
1615744 "required": [
1715771 "enabled",
1815771 "from",
1915771 "replyTo",
2015771 "transport"
2115744 ],
2215785 "type": "object"
23151271}
AdminConfigSmtpTransportDto13 of 13 keywords
1153047{
2153636 "properties": {
315665 "host": {
415665 "type": "string"
515665 },
615665 "ignoreCert": {
715665 "type": "boolean"
815665 },
915665 "password": {
1015665 "type": "string"
1115665 },
1215638 "port": {
1315651 "maximum": 65535,
1415651 "minimum": 0,
1515656 "type": "integer"
1615638 },
1715638 "secure": {
1815638 "type": "boolean"
1915638 },
2015665 "username": {
2115665 "type": "string"
2215665 }
23153636 },
2415666 "required": [
2515711 "ignoreCert",
2615711 "host",
2715711 "port",
2815711 "secure",
2915711 "username",
3015711 "password"
3115666 ],
3215725 "type": "object"
33153047}
AdminConfigStorageTemplateDto8 of 8 keywords
1156623{
2156915 "properties": {
315785 "enabled": {
415785 "type": "boolean"
515785 },
615785 "hashVerificationEnabled": {
715785 "type": "boolean"
815785 },
915785 "template": {
1015785 "type": "string"
1115785 }
12156915 },
1315813 "required": [
1415831 "enabled",
1515831 "hashVerificationEnabled",
1615831 "template"
1715813 ],
1815845 "type": "object"
19156623}
AdminConfigTemplateEmailsDto8 of 8 keywords
1156023{
2156315 "properties": {
315725 "albumInviteTemplate": {
415725 "type": "string"
515725 },
615725 "albumUpdateTemplate": {
715725 "type": "string"
815725 },
915725 "welcomeTemplate": {
1015725 "type": "string"
1115725 }
12156315 },
1315753 "required": [
1415771 "welcomeTemplate",
1515771 "albumInviteTemplate",
1615771 "albumUpdateTemplate"
1715753 ],
1815785 "type": "object"
19156023}
AdminConfigTemplatesDto6 of 6 keywords
1156029{
2156023 "properties": {
3156023 "email": {
5156023 }
6156023 },
715831 "required": [
815831 "email"
915831 ],
1015845 "type": "object"
11156029}
AdminConfigThemeDto6 of 6 keywords
1157811{
215785 "properties": {
315785 "customCss": {
415785 "type": "string"
515785 }
615785 },
715831 "required": [
815831 "customCss"
915831 ],
1015845 "type": "object"
11157811}
AdminConfigTrashDto9 of 9 keywords
1156920{
2157113 "properties": {
315758 "days": {
415771 "maximum": 9007199254740991,
515771 "minimum": 0,
615776 "type": "integer"
715758 },
815785 "enabled": {
915785 "type": "boolean"
1015785 }
11157113 },
1215822 "required": [
1315831 "enabled",
1415831 "days"
1515822 ],
1615845 "type": "object"
17156920}
AdminConfigUserDto8 of 8 keywords
1157514{
215758 "properties": {
315758 "deleteDelay": {
415771 "maximum": 9007199254740991,
515762 "minimum": 1,
615776 "type": "integer"
715758 }
815758 },
915831 "required": [
1015831 "deleteDelay"
1115831 ],
1215845 "type": "object"
13157514}
AudioCodec3 of 3 keywords
1212812{
2212812 "enum": [
31573n/a "mp3",
4241n/a "aac",
5157n/a "opus",
6157n/a "pcm_s16le"
7212812 ],
8213010 "type": "string"
9212812}
CQMode3 of 3 keywords
115776{
215776 "enum": [
31429n/a "auto",
4114n/a "cqp",
534n/a "icq"
615776 ],
715785 "type": "string"
815776}
Colorspace3 of 3 keywords
115776{
215776 "enum": [
31467n/a "srgb",
4110n/a "p3"
515776 ],
615785 "type": "string"
715776}
HlsVideoResolution3 of 3 keywords
13667{
23667 "enum": [
378n/a 480,
463n/a 720,
568n/a 1080,
666n/a 1440,
791n/a 2160
83667 ],
93676 "type": "integer"
103667}
ImageFormat3 of 3 keywords
1471018{
2471018 "enum": [
34570n/a "jpeg",
4140n/a "webp"
5471018 ],
6471315 "type": "string"
7471018}
LogLevel3 of 3 keywords
115776{
215776 "enum": [
31406n/a "verbose",
421n/a "debug",
588n/a "log",
628n/a "warn",
716n/a "error",
818n/a "fatal"
915776 ],
1015785 "type": "string"
1115776}
OAuthTokenEndpointAuthMethod3 of 3 keywords
115776{
215776 "enum": [
31525n/a "client_secret_post",
452n/a "client_secret_basic"
515776 ],
615785 "type": "string"
715776}
ReleaseChannel3 of 3 keywords
115776{
215776 "enum": [
31527n/a "stable",
450n/a "releaseCandidate"
515776 ],
615785 "type": "string"
715776}
ToneMapping3 of 3 keywords
115776{
215776 "enum": [
31500n/a "hable",
422n/a "mobius",
519n/a "reinhard",
636n/a "disabled"
715776 ],
815785 "type": "string"
915776}
TranscodeHWAccel3 of 3 keywords
115776{
215776 "enum": [
31432n/a "nvenc",
483n/a "qsv",
530n/a "vaapi",
612n/a "rkmpp",
720n/a "disabled"
815776 ],
915785 "type": "string"
1015776}
TranscodePolicy3 of 3 keywords
115776{
215776 "enum": [
31485n/a "all",
428n/a "optimal",
538n/a "bitrate",
612n/a "required",
714n/a "disabled"
815776 ],
915785 "type": "string"
1015776}
VideoCodec3 of 3 keywords
1254019{
2254019 "enum": [
31650n/a "h264",
4271n/a "hevc",
5232n/a "vp9",
6387n/a "av1"
7254019 ],
8254415 "type": "string"
9254019}
VideoContainer3 of 3 keywords
15696{
25696 "enum": [
384n/a "mov",
4189n/a "mp4",
5129n/a "ogg",
6167n/a "webm"
75696 ],
85705 "type": "string"
95696}
Responses
codedescriptionhitsavg
2007712ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request15103ms
401Unauthorized361ms
Examples
Body: application/json
""AdminConfigOAuthDto.accountManagementUrl
Responses
codedescriptionhitsavg
2001651ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3451ms
Responses
codedescriptionhitsavg
2001691ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3421ms
System metadata 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
2001951ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3161ms
Body
application/json4 / 4
AdminOnboardingUpdateDto
#validinvalidschema
1265211{
226559 "properties": {
326559 "isOnboarded": {
426559 "type": "boolean"
526559 }
626559 },
7324122 "required": [
8324122 "isOnboarded"
9324122 ],
1044630 "type": "object"
11265211}
Responses
codedescriptionhitsavg
2042103ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized551ms
400Bad Request2581ms
Responses
codedescriptionhitsavg
2001691ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3421ms
Responses
codedescriptionhitsavg
2001541ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3571ms
Tags 9 operations 9 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
20033762ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized6211ms
Body
application/json12 / 12
TagCreateDto
#validinvalidschema
140181{
241157 "properties": {
313636 "color": {
4172n/a "nullable": true,
511323 "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
615913 "type": "string"
713636 },
844117 "name": {
94411 "pattern": "^[^/]*$",
1044216 "type": "string"
1144117 },
129140 "parentId": {
132112 "format": "uuid",
14131n/a "nullable": true,
152112 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
1610328 "type": "string"
179140 }
1841157 },
1945817 "required": [
2045817 "name"
2145817 ],
224757 "type": "object"
2340181}
Responses
codedescriptionhitsavg
201875ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized491ms
400Bad Request3852ms
500Internal Server Error12ms
Body
application/json5 / 5
TagUpsertDto
#validinvalidschema
140476{
240447 "properties": {
340447 "tags": {
440437 "items": {
52310307 "type": "string"
640437 },
744110 "type": "array"
840447 }
940447 },
1045122 "required": [
1145122 "tags"
1245122 ],
134737 "type": "object"
1440476}
Responses
codedescriptionhitsavg
20033211ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized651ms
400Bad Request1071ms
500Internal Server Error710ms
Body
application/json11 / 11
TagBulkAssetsDto
#validinvalidschema
1235226{
2241201 "properties": {
3252188 "assetIds": {
425214 "items": {
521142 "format": "uuid",
621142 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
725318 "type": "string"
825214 },
9266174 "type": "array"
10252188 },
11249189 "tagIds": {
1224980 "items": {
13863 "format": "uuid",
14863 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
1571202 "type": "string"
1624980 },
17329109 "type": "array"
18249189 }
19241201 },
2043610 "required": [
214388 "tagIds",
224406 "assetIds"
2343610 ],
2444615 "type": "object"
25235226}
Responses
codedescriptionhitsavg
2001392ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized961ms
400Bad Request2931ms
Path Parameters
id3 / 3
#validinvalidschema
127419{
227419 "format": "uuid",
327419 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4293n/a "type": "string"
527419}
Responses
codedescriptionhitsavg
2041705ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized421ms
400Bad Request811ms
Path Parameters
id3 / 3
#validinvalidschema
161342{
261342 "format": "uuid",
361342 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4655n/a "type": "string"
561342}
Responses
codedescriptionhitsavg
2004572ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized681ms
400Bad Request1302ms
Path Parameters
id3 / 3
#validinvalidschema
165115{
265115 "format": "uuid",
365115 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4666n/a "type": "string"
565115}
Body
application/json7 / 7
TagUpdateDto
159444{
221127 "properties": {
318520 "color": {
4205n/a "nullable": true,
51592 "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
618718 "type": "string"
718520 },
815721 "name": {
91575 "pattern": "^[^/]*$",
1016216 "type": "string"
1115721 }
1221127 },
1362117 "type": "object"
1459444}
Responses
codedescriptionhitsavg
2004255ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized341ms
400Bad Request1792ms
500Internal Server Error283ms
Path Parameters
id3 / 3
#validinvalidschema
129235{
229235 "format": "uuid",
329235 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4327n/a "type": "string"
529235}
Body
application/json7 / 7
BulkIdsDto
119320{
219314 "properties": {
319314 "ids": {
41938 "items": {
52351 "format": "uuid",
62351 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
723625 "type": "string"
81938 },
92016 "type": "array"
1019314 }
1119314 },
122071 "required": [
132071 "ids"
142071 ],
152085 "type": "object"
1619320}
Responses
codedescriptionhitsavg
200842ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2151ms
401Unauthorized281ms
Path Parameters
id3 / 3
#validinvalidschema
155653{
255653 "format": "uuid",
355653 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4609n/a "type": "string"
555653}
Body
application/json7 / 7
BulkIdsDto
151834{
251824 "properties": {
351824 "ids": {
451816 "items": {
54953 "format": "uuid",
64953 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
749830 "type": "string"
851816 },
95348 "type": "array"
1051824 }
1151824 },
125424 "required": [
135424 "ids"
145424 ],
155466 "type": "object"
1651834}
Responses
codedescriptionhitsavg
2004062ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized231ms
400Bad Request1801ms
Timeline 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
userId3 / 3
#validinvalidschema
173221{
273221 "format": "uuid",
373221 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4753n/a "type": "string"
573221}
albumId3 / 3
175216{
275216 "format": "uuid",
375216 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4768n/a "type": "string"
575216}
personId3 / 3
173314{
273314 "format": "uuid",
373314 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4747n/a "type": "string"
573314}
tagId3 / 3
174515{
274515 "format": "uuid",
374515 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4760n/a "type": "string"
574515}
isFavorite1 / 1
118215{
218215 "type": "boolean"
318215}
isTrashed1 / 1
120611{
220611 "type": "boolean"
320611}
withStacked1 / 1
117511{
217511 "type": "boolean"
317511}
withPartners1 / 1
119010{
219010 "type": "boolean"
319010}
order2 / 2
AssetOrder
119515{
219515 "enum": [
3144n/a "asc",
451n/a "desc"
519515 ],
6210n/a "type": "string"
719515}
orderBy2 / 2
AssetOrderBy
120112{
220112 "enum": [
3135n/a "takenAt",
466n/a "createdAt"
520112 ],
6213n/a "type": "string"
720112}
visibility2 / 2
AssetVisibility
119514{
219514 "enum": [
3114n/a "archive",
425n/a "timeline",
537n/a "hidden",
619n/a "locked"
719514 ],
8209n/a "type": "string"
919514}
withCoordinates1 / 1
118011{
218011 "type": "boolean"
318011}
key1 / 1
1243n/a{
2243n/a "type": "string"
3243n/a}
slug1 / 1
1190n/a{
2190n/a "type": "string"
3190n/a}
bbox1 / 1
1393n/a{
2393n/a "type": "string"
3393n/a}
timeBucket1 / 1
11216n/a{
21216n/a "type": "string"
31216n/a}
Responses
codedescriptionhitsavg
2003123ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2921ms
400Bad Request5922ms
500Internal Server Error223ms
Examples
Query
"11.075683,49.416711,11.117589,49.454875"bbox
"2024-01-01T00:00:00.000Z"timeBucket
Query Parameters
userId3 / 3
#validinvalidschema
174424{
274424 "format": "uuid",
374424 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4768n/a "type": "string"
574424}
albumId3 / 3
175926{
275926 "format": "uuid",
375926 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4785n/a "type": "string"
575926}
personId3 / 3
174126{
274126 "format": "uuid",
374126 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4767n/a "type": "string"
574126}
tagId3 / 3
174320{
274320 "format": "uuid",
374320 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4763n/a "type": "string"
574320}
isFavorite1 / 1
121514{
221514 "type": "boolean"
321514}
isTrashed1 / 1
122817{
222817 "type": "boolean"
322817}
withStacked1 / 1
119115{
219115 "type": "boolean"
319115}
withPartners1 / 1
120514{
220514 "type": "boolean"
320514}
order2 / 2
AssetOrder
121220{
221220 "enum": [
3156n/a "asc",
456n/a "desc"
521220 ],
6232n/a "type": "string"
721220}
orderBy2 / 2
AssetOrderBy
123215{
223215 "enum": [
3147n/a "takenAt",
485n/a "createdAt"
523215 ],
6247n/a "type": "string"
723215}
visibility2 / 2
AssetVisibility
119114{
219114 "enum": [
3103n/a "archive",
425n/a "timeline",
531n/a "hidden",
632n/a "locked"
719114 ],
8205n/a "type": "string"
919114}
withCoordinates1 / 1
125013{
225013 "type": "boolean"
325013}
key1 / 1
1216n/a{
2216n/a "type": "string"
3216n/a}
slug1 / 1
1229n/a{
2229n/a "type": "string"
3229n/a}
bbox1 / 1
1428n/a{
2428n/a "type": "string"
3428n/a}
Responses
codedescriptionhitsavg
2003382ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2431ms
400Bad Request6602ms
500Internal Server Error31ms
Examples
Query
"11.075683,49.416711,11.117589,49.454875"bbox
Trash 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
2001801ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3311ms
Responses
codedescriptionhitsavg
2001681ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3441ms
Body
application/json7 / 7
BulkIdsDto
#validinvalidschema
11176191{
21176140 "properties": {
31176140 "ids": {
4117644 "items": {
51503239 "format": "uuid",
61503239 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
7174232 "type": "string"
8117644 },
9122096 "type": "array"
101176140 }
111176140 },
12131633 "required": [
13131633 "ids"
14131633 ],
15134918 "type": "object"
161176191}
Responses
codedescriptionhitsavg
2001912ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized891ms
400Bad Request12232ms
Users 16 operations 15 covered 1 partial 0 uncovered 0 not measured 96% #
Responses
codedescriptionhitsavg
20034715ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5711ms
Responses
codedescriptionhitsavg
20035272ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5871ms
Body
application/json8 / 12
UserUpdateMeDto
#validinvalidschema
1327205{
2187192 "properties": {
392190 "avatarColor": {
41n/a "allOf": [
592190 {
792190 }
81n/a ],
9282n/a "nullable": true
1092190 },
1100 "email": {
1200 "format": "email",
1300 "pattern": "^[\\p{L}\\p{M}\\p{N}.!#$%&'*+/=?^_`{|}~-]+@[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?(?:\\.[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?)*$",
1400 "type": "string"
1500 },
1622412 "name": {
1722412 "type": "string"
1822412 },
1900 "password": {
2000 "type": "string"
2100 }
22187192 },
2351913 "type": "object"
24327205}
Referenced Components (1)3 of 3 keywords
UserAvatarColor3 of 3 keywords
192190{
292190 "enum": [
38n/a "primary",
44n/a "pink",
559n/a "red",
64n/a "yellow",
73n/a "blue",
83n/a "green",
91n/a "purple",
104n/a "orange",
112n/a "gray",
124n/a "amber"
1392190 ],
1495187 "type": "string"
1592190}
Responses
codedescriptionhitsavg
2003303ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized331ms
400Bad Request581ms
500Internal Server Error1352ms
Query Parameters
from3 / 3
#validinvalidschema
111954{
211954 "format": "date",
311954 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
4173n/a "type": "string"
511954}
to3 / 3
112347{
212347 "format": "date",
312347 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
4170n/a "type": "string"
512347}
type2 / 2
CalendarHeatmapType
17255{
27255 "enum": [
344n/a "Upload",
428n/a "Taken"
57255 ],
6127n/a "type": "string"
77255}
Responses
codedescriptionhitsavg
20024446ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized521ms
400Bad Request1101ms
Examples
Query
"2024-01-01"from
"2024-01-01"to
Responses
codedescriptionhitsavg
2041781ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3331ms
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1871ms
401Unauthorized3201ms
Body
application/json6 / 6
LicenseKeyDto
#validinvalidschema
116769{
218049 "properties": {
320226 "activationKey": {
420226 "type": "string"
520226 },
618334 "licenseKey": {
718324 "pattern": "^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$",
820710 "type": "string"
918334 }
1018049 },
1121614 "required": [
1221713 "licenseKey",
132282 "activationKey"
1421614 ],
152306 "type": "object"
1616769}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5041ms
401Unauthorized221ms
Responses
codedescriptionhitsavg
2041741ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3361ms
Responses
codedescriptionhitsavg
2001741ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3371ms
Body
application/json4 / 4
OnboardingDto
#validinvalidschema
1266213{
226687 "properties": {
326687 "isOnboarded": {
426687 "type": "boolean"
526687 }
626687 },
7353108 "required": [
8353108 "isOnboarded"
9353108 ],
1046118 "type": "object"
11266213}
Responses
codedescriptionhitsavg
2001893ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized771ms
400Bad Request2571ms
Responses
codedescriptionhitsavg
2001851ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3251ms
Body
application/json78 / 78
UserPreferencesUpdateDto
#validinvalidschema
1452289{
2297277 "properties": {
343328 "albums": {
543328 },
639533 "avatar": {
839533 },
940428 "cast": {
1140428 },
1241625 "download": {
1441625 },
1539220 "emailNotifications": {
1739220 },
1838031 "folders": {
2038031 },
2140327 "memories": {
2340327 },
2436958 "people": {
2636958 },
2738416 "purchase": {
2938416 },
3039010 "ratings": {
3239010 },
3338518 "recentlyAdded": {
3538518 },
3638043 "sharedLinks": {
3838043 },
3939116 "tags": {
4139116 }
42297277 },
4372912 "type": "object"
44452289}
Referenced Components (16)79 of 79 keywords
AlbumsUpdate4 of 4 keywords
143328{
23546 "properties": {
33546 "defaultAssetOrder": {
53546 }
63546 },
743922 "type": "object"
843328}
AssetOrder3 of 3 keywords
13546{
23546 "enum": [
3314n/a "asc",
440n/a "desc"
53546 ],
63555 "type": "string"
73546}
AvatarUpdate4 of 4 keywords
139533{
232815 "properties": {
332815 "color": {
532815 }
632815 },
741018 "type": "object"
839533}
CastUpdate4 of 4 keywords
140428{
23525 "properties": {
33525 "gCastEnabled": {
43525 "type": "boolean"
53525 }
63525 },
740923 "type": "object"
840428}
DownloadUpdate7 of 7 keywords
141625{
235113 "properties": {
33308 "archiveSize": {
43321 "maximum": 9007199254740991,
53312 "minimum": 1,
63326 "type": "integer"
73308 },
83405 "includeEmbeddedVideos": {
93405 "type": "boolean"
103405 }
1135113 },
1242912 "type": "object"
1341625}
EmailNotificationsUpdate6 of 6 keywords
139220{
234615 "properties": {
33235 "albumInvite": {
43235 "type": "boolean"
53235 },
63415 "albumUpdate": {
73415 "type": "boolean"
83415 },
93105 "enabled": {
103105 "type": "boolean"
113105 }
1234615 },
134075 "type": "object"
1439220}
FoldersUpdate5 of 5 keywords
138031{
234424 "properties": {
33595 "enabled": {
43595 "type": "boolean"
53595 },
633919 "sidebarWeb": {
733919 "type": "boolean"
833919 }
934424 },
104047 "type": "object"
1138031}
MemoriesUpdate8 of 8 keywords
140327{
236522 "properties": {
336211 "duration": {
43662 "maximum": 9007199254740991,
53644 "minimum": 1,
63676 "type": "integer"
736211 },
83395 "enabled": {
93395 "type": "boolean"
103395 },
113376 "sidebarWeb": {
123376 "type": "boolean"
133376 }
1436522 },
154255 "type": "object"
1640327}
PeopleUpdate9 of 9 keywords
136958{
232741 "properties": {
333617 "enabled": {
433617 "type": "boolean"
533617 },
632813 "minimumFaces": {
73315 "maximum": 9007199254740991,
83333 "minimum": 1,
93356 "type": "integer"
1032813 },
113235 "sidebarWeb": {
123235 "type": "boolean"
133235 },
143136 "updateStrategy": {
163136 }
1732741 },
1841017 "type": "object"
1936958}
PersonUpdateStrategy3 of 3 keywords
13136{
23136 "enum": [
3302n/a "self",
411n/a "everyone"
53136 ],
63145 "type": "string"
73136}
PurchaseUpdate5 of 5 keywords
138416{
233210 "properties": {
33315 "hideBuyButtonUntil": {
43315 "type": "string"
53315 },
63035 "showSupportBadge": {
73035 "type": "boolean"
83035 }
933210 },
103946 "type": "object"
1138416}
RatingsUpdate4 of 4 keywords
139010{
23435 "properties": {
33435 "enabled": {
43435 "type": "boolean"
53435 }
63435 },
73955 "type": "object"
839010}
RecentlyAddedUpdate4 of 4 keywords
138518{
233813 "properties": {
333813 "sidebarWeb": {
433813 "type": "boolean"
533813 }
633813 },
73985 "type": "object"
838518}
SharedLinksUpdate5 of 5 keywords
138043{
233836 "properties": {
334314 "enabled": {
434314 "type": "boolean"
534314 },
631822 "sidebarWeb": {
731822 "type": "boolean"
831822 }
933836 },
104167 "type": "object"
1138043}
TagsUpdate5 of 5 keywords
139116{
235010 "properties": {
33435 "enabled": {
43435 "type": "boolean"
53435 },
63365 "sidebarWeb": {
73365 "type": "boolean"
83365 }
935010 },
104016 "type": "object"
1139116}
UserAvatarColor3 of 3 keywords
132815{
232815 "enum": [
3285n/a "primary",
42n/a "pink",
54n/a "red",
69n/a "yellow",
73n/a "blue",
81n/a "green",
97n/a "purple",
102n/a "orange",
1112n/a "gray",
123n/a "amber"
1332815 ],
143385 "type": "string"
1532815}
Responses
codedescriptionhitsavg
2004254ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized271ms
400Bad Request3121ms
Responses
codedescriptionhitsavg
20478ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3151ms
400Bad Request1881ms
Body
multipart/form-data5 / 5
CreateProfileImageDto
#validinvalidschema
120660{
2206n/a "properties": {
3206n/a "file": {
4206n/a "format": "binary",
5206n/a "type": "string"
6206n/a }
7206n/a },
820660 "required": [
920660 "file"
1020660 ],
11266n/a "type": "object"
1220660}
Responses
codedescriptionhitsavg
2017615ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized731ms
500Internal Server Error262ms
400Bad Request3382ms
Path Parameters
id3 / 3
#validinvalidschema
159266{
259266 "format": "uuid",
359266 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4658n/a "type": "string"
559266}
Responses
codedescriptionhitsavg
2001312ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized691ms
400Bad Request4582ms
Path Parameters
id3 / 3
#validinvalidschema
167038{
267038 "format": "uuid",
367038 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4708n/a "type": "string"
567038}
Responses
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6132ms
400Bad Request382ms
401Unauthorized571ms
Users (admin) 11 operations 10 covered 1 partial 0 uncovered 0 not measured 97% #
Query Parameters
withDeleted1 / 1
#validinvalidschema
11077105{
21077105 "type": "boolean"
31077105}
id3 / 3
12608117{
22608117 "format": "uuid",
32608117 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
42725n/a "type": "string"
52608117}
Responses
codedescriptionhitsavg
20026742ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2681ms
400Bad Request1352ms
Body
application/json25 / 25
UserAdminCreateDto
#validinvalidschema
128261062{
228391042 "properties": {
3806961 "avatarColor": {
41n/a "allOf": [
5806961 {
7806961 }
81n/a ],
91767n/a "nullable": true
10806961 },
11380262 "email": {
12380955 "format": "email",
13380255 "pattern": "^[\\p{L}\\p{M}\\p{N}.!#$%&'*+/=?^_`{|}~-]+@[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?(?:\\.[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?)*$",
1438577 "type": "string"
15380262 },
1617118 "isAdmin": {
1717118 "type": "boolean"
1817118 },
19386910 "name": {
20386910 "type": "string"
21386910 },
22169412 "notify": {
23169412 "type": "boolean"
24169412 },
25386217 "password": {
26386217 "type": "string"
27386217 },
28160937 "pinCode": {
291646n/a "nullable": true,
3073013 "pattern": "^\\d{6}$",
31162224 "type": "string"
32160937 },
33164642 "quotaSizeInBytes": {
3413614 "maximum": 9007199254740991,
3513569 "minimum": 0,
361688n/a "nullable": true,
37165731 "type": "integer"
38164642 },
3917058 "shouldChangePassword": {
4017058 "type": "boolean"
4117058 },
42165425 "storageLabel": {
431679n/a "nullable": true,
44165425 "type": "string"
45165425 }
4628391042 },
47386219 "required": [
48386417 "email",
4938792 "password",
5038792 "name"
51386219 ],
5238817 "type": "object"
5328261062}
Referenced Components (1)3 of 3 keywords
UserAvatarColor3 of 3 keywords
1806961{
2806961 "enum": [
380n/a "primary",
467n/a "pink",
573n/a "red",
696n/a "yellow",
773n/a "blue",
887n/a "green",
979n/a "purple",
1078n/a "orange",
1192n/a "gray",
1281n/a "amber"
13806961 ],
14827940 "type": "string"
15806961}
Responses
codedescriptionhitsavg
20132742ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request31784ms
401Unauthorized1341ms
500Internal Server Error43440ms
Examples
Body: application/json
"123456"UserAdminCreateDto.pinCode
Path Parameters
id3 / 3
#validinvalidschema
146529{
246529 "format": "uuid",
346529 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4494n/a "type": "string"
546529}
Body
application/json3 / 3
UserAdminDeleteDto
138536{
217610 "properties": {
317610 "force": {
417610 "type": "boolean"
517610 }
617610 },
739526 "type": "object"
838536}
Responses
codedescriptionhitsavg
2002236ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized291ms
400Bad Request2421ms
Path Parameters
id3 / 3
#validinvalidschema
192230{
292230 "format": "uuid",
392230 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4952n/a "type": "string"
592230}
Responses
codedescriptionhitsavg
2007852ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1091ms
400Bad Request582ms
Path Parameters
id3 / 3
#validinvalidschema
189323{
289323 "format": "uuid",
389323 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4916n/a "type": "string"
589323}
Body
application/json19 / 23
UserAdminUpdateDto
1631242{
2274232 "properties": {
3129223 "avatarColor": {
41n/a "allOf": [
5129223 {
7129223 }
81n/a ],
9352n/a "nullable": true
10129223 },
1100 "email": {
1200 "format": "email",
1300 "pattern": "^[\\p{L}\\p{M}\\p{N}.!#$%&'*+/=?^_`{|}~-]+@[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?(?:\\.[\\p{L}\\p{N}](?:[\\p{L}\\p{M}\\p{N}-]{0,61}[\\p{L}\\p{M}\\p{N}])?)*$",
1400 "type": "string"
1500 },
1633710 "isAdmin": {
1733710 "type": "boolean"
1833710 },
1932311 "name": {
2032311 "type": "string"
2132311 },
2200 "password": {
2300 "type": "string"
2400 },
2531725 "pinCode": {
26342n/a "nullable": true,
271805 "pattern": "^\\d{6}$",
2832220 "type": "string"
2931725 },
3032015 "quotaSizeInBytes": {
312643 "maximum": 9007199254740991,
322661 "minimum": 0,
33335n/a "nullable": true,
3432411 "type": "integer"
3532015 },
363307 "shouldChangePassword": {
373307 "type": "boolean"
383307 },
3934116 "storageLabel": {
40357n/a "nullable": true,
4134116 "type": "string"
4234116 }
43274232 },
4486310 "type": "object"
45631242}
Referenced Components (1)3 of 3 keywords
UserAvatarColor3 of 3 keywords
1129223{
2129223 "enum": [
325n/a "primary",
43n/a "pink",
57n/a "red",
617n/a "yellow",
79n/a "blue",
814n/a "green",
923n/a "purple",
108n/a "orange",
1114n/a "gray",
129n/a "amber"
13129223 ],
14135217 "type": "string"
15129223}
Responses
codedescriptionhitsavg
2005407ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2792ms
401Unauthorized371ms
500Internal Server Error6014ms
Examples
Body: application/json
"123456"UserAdminUpdateDto.pinCode
Path Parameters
id3 / 3
#validinvalidschema
165037{
265037 "format": "uuid",
365037 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4687n/a "type": "string"
565037}
Query Parameters
from3 / 3
127255{
227255 "format": "date",
327255 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
4327n/a "type": "string"
527255}
to3 / 3
127853{
227853 "format": "date",
327853 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
4331n/a "type": "string"
527853}
type2 / 2
CalendarHeatmapType
120348{
220348 "enum": [
3107n/a "Upload",
496n/a "Taken"
520348 ],
6251n/a "type": "string"
720348}
Responses
codedescriptionhitsavg
200432121ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2231ms
401Unauthorized321ms
Examples
Query
"2024-01-01"from
"2024-01-01"to
Path Parameters
id3 / 3
#validinvalidschema
169947{
269947 "format": "uuid",
369947 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4746n/a "type": "string"
569947}
Responses
codedescriptionhitsavg
2005732ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized861ms
400Bad Request872ms
Path Parameters
id3 / 3
#validinvalidschema
194737{
294737 "format": "uuid",
394737 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4984n/a "type": "string"
594737}
Body
application/json78 / 78
UserPreferencesUpdateDto
1713247{
2372242 "properties": {
343913 "albums": {
543913 },
642517 "avatar": {
842517 },
941711 "cast": {
1141711 },
1240828 "download": {
1440828 },
1540122 "emailNotifications": {
1740122 },
1842315 "folders": {
2042315 },
2138737 "memories": {
2338737 },
2440233 "people": {
2640233 },
2740922 "purchase": {
2940922 },
3041214 "ratings": {
3241214 },
3339816 "recentlyAdded": {
3539816 },
3638319 "sharedLinks": {
3838319 },
3941818 "tags": {
4141818 }
42372242 },
439555 "type": "object"
44713247}
Referenced Components (16)79 of 79 keywords
AlbumsUpdate4 of 4 keywords
143913{
23547 "properties": {
33547 "defaultAssetOrder": {
53547 }
63547 },
74466 "type": "object"
843913}
AssetOrder3 of 3 keywords
13547{
23547 "enum": [
3324n/a "asc",
430n/a "desc"
53547 ],
63565 "type": "string"
73547}
AvatarUpdate4 of 4 keywords
142517{
23468 "properties": {
33468 "color": {
53468 }
63468 },
74339 "type": "object"
842517}
CastUpdate4 of 4 keywords
141711{
23535 "properties": {
33535 "gCastEnabled": {
43535 "type": "boolean"
53535 }
63535 },
74226 "type": "object"
841711}
DownloadUpdate7 of 7 keywords
140828{
235021 "properties": {
33479 "archiveSize": {
43501 "maximum": 9007199254740991,
53483 "minimum": 1,
63506 "type": "integer"
73479 },
834912 "includeEmbeddedVideos": {
934912 "type": "boolean"
1034912 }
1135021 },
124297 "type": "object"
1340828}
EmailNotificationsUpdate6 of 6 keywords
140122{
236416 "properties": {
33595 "albumInvite": {
43595 "type": "boolean"
53595 },
63465 "albumUpdate": {
73465 "type": "boolean"
83465 },
93406 "enabled": {
103406 "type": "boolean"
113406 }
1236416 },
134176 "type": "object"
1440122}
FoldersUpdate5 of 5 keywords
142315{
236610 "properties": {
33545 "enabled": {
43545 "type": "boolean"
53545 },
63515 "sidebarWeb": {
73515 "type": "boolean"
83515 }
936610 },
104335 "type": "object"
1142315}
MemoriesUpdate8 of 8 keywords
138737{
234232 "properties": {
33319 "duration": {
43332 "maximum": 9007199254740991,
53332 "minimum": 1,
63346 "type": "integer"
73319 },
833716 "enabled": {
933716 "type": "boolean"
1033716 },
113457 "sidebarWeb": {
123457 "type": "boolean"
133457 }
1434232 },
154195 "type": "object"
1638737}
PeopleUpdate9 of 9 keywords
140233{
237228 "properties": {
33607 "enabled": {
43607 "type": "boolean"
53607 },
63359 "minimumFaces": {
73372 "maximum": 9007199254740991,
83372 "minimum": 1,
93386 "type": "integer"
103359 },
113365 "sidebarWeb": {
123365 "type": "boolean"
133365 },
143417 "updateStrategy": {
163417 }
1737228 },
184305 "type": "object"
1940233}
PersonUpdateStrategy3 of 3 keywords
13417{
23417 "enum": [
3323n/a "self",
418n/a "everyone"
53417 ],
63435 "type": "string"
73417}
PurchaseUpdate5 of 5 keywords
140922{
235317 "properties": {
334411 "hideBuyButtonUntil": {
434411 "type": "string"
534411 },
63456 "showSupportBadge": {
73456 "type": "boolean"
83456 }
935317 },
104265 "type": "object"
1140922}
RatingsUpdate4 of 4 keywords
141214{
23465 "properties": {
33465 "enabled": {
43465 "type": "boolean"
53465 }
63465 },
74179 "type": "object"
841214}
RecentlyAddedUpdate4 of 4 keywords
139816{
23507 "properties": {
33507 "sidebarWeb": {
43507 "type": "boolean"
53507 }
63507 },
74059 "type": "object"
839816}
SharedLinksUpdate5 of 5 keywords
138319{
233913 "properties": {
33308 "enabled": {
43308 "type": "boolean"
53308 },
63235 "sidebarWeb": {
73235 "type": "boolean"
83235 }
933913 },
103966 "type": "object"
1138319}
TagsUpdate5 of 5 keywords
141818{
236112 "properties": {
33527 "enabled": {
43527 "type": "boolean"
53527 },
63345 "sidebarWeb": {
73345 "type": "boolean"
83345 }
936112 },
104306 "type": "object"
1141818}
UserAvatarColor3 of 3 keywords
13468{
23468 "enum": [
3285n/a "primary",
48n/a "pink",
57n/a "red",
66n/a "yellow",
75n/a "blue",
84n/a "green",
96n/a "purple",
1010n/a "orange",
118n/a "gray",
127n/a "amber"
133468 ],
143495 "type": "string"
153468}
Responses
codedescriptionhitsavg
2005904ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized251ms
400Bad Request3671ms
500Internal Server Error24ms
Path Parameters
id3 / 3
#validinvalidschema
11929107{
21929107 "format": "uuid",
31929107 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
42036n/a "type": "string"
51929107}
Responses
codedescriptionhitsavg
20014985ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1021ms
400Bad Request4362ms
Path Parameters
id3 / 3
#validinvalidschema
161338{
261338 "format": "uuid",
361338 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4651n/a "type": "string"
561338}
Responses
codedescriptionhitsavg
2005412ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized721ms
400Bad Request381ms
Path Parameters
id3 / 3
#validinvalidschema
168944{
268944 "format": "uuid",
368944 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4733n/a "type": "string"
568944}
Query Parameters
visibility2 / 2
AssetVisibility
118868{
218868 "enum": [
383n/a "archive",
430n/a "timeline",
540n/a "hidden",
635n/a "locked"
718868 ],
8256n/a "type": "string"
918868}
isFavorite1 / 1
121272{
221272 "type": "boolean"
321272}
isTrashed1 / 1
120455{
220455 "type": "boolean"
320455}
Responses
codedescriptionhitsavg
2005602ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized211ms
400Bad Request1521ms
Views 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
path1 / 1
#validinvalidschema
13620n/a{
23620n/a "type": "string"
33620n/a}
Responses
codedescriptionhitsavg
20032302ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3431ms
500Internal Server Error482ms
Responses
codedescriptionhitsavg
2001571ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3541ms
Workflows 8 operations 6 covered 2 partial 0 uncovered 0 not measured 97% #
Query Parameters
id3 / 3
#validinvalidschema
1279457{
2279457 "format": "uuid",
3279457 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
42851n/a "type": "string"
5279457}
trigger2 / 2
WorkflowTrigger
1110248{
2110248 "enum": [
3434n/a "AssetCreate",
4358n/a "AssetMetadataExtraction",
5310n/a "AssetTagged"
6110248 ],
71150n/a "type": "string"
8110248}
name1 / 1
11157n/a{
21157n/a "type": "string"
31157n/a}
description1 / 1
11268n/a{
21268n/a "type": "string"
31268n/a}
enabled1 / 1
1117333{
2117333 "type": "boolean"
3117333}
logging1 / 1
1115233{
2115233 "type": "boolean"
3115233}
Responses
codedescriptionhitsavg
20015403ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request15162ms
401Unauthorized2271ms
Body
application/json22 / 23
WorkflowCreateDto
#validinvalidschema
13597179{
23613143 "properties": {
3179820 "description": {
41818n/a "nullable": true,
5179820 "type": "string"
6179820 },
7171010 "enabled": {
8171010 "type": "boolean"
9171010 },
1017468 "logging": {
1117468 "type": "boolean"
1217468 },
13171522 "name": {
141737n/a "nullable": true,
15171522 "type": "string"
16171522 },
17171174 "steps": {
18171164 "items": {
20171164 },
21177510 "type": "array"
22171174 },
23369644 "trigger": {
25369644 }
263613143 },
27374028 "required": [
28374028 "trigger"
29374028 ],
3037688 "type": "object"
313597179}
Referenced Components (2)13 of 14 keywords
WorkflowStepDto10 of 11 keywords
17615224{
27684146 "properties": {
3774637 "config": {
43096n/a "additionalProperties": {},
57783n/a "nullable": true,
60n/a "propertyNames": {
70n/a "type": "string"
80n/a },
9774637 "type": "object"
10774637 },
11389570 "enabled": {
12389570 "type": "boolean"
13389570 },
14776147 "method": {
15776147 "type": "string"
16776147 }
177684146 },
18776171 "required": [
19780824 "method",
20778349 "config"
21776171 ],
2278327 "type": "object"
237615224}
WorkflowTrigger3 of 3 keywords
1369644{
2369644 "enum": [
31440n/a "AssetCreate",
41100n/a "AssetMetadataExtraction",
51156n/a "AssetTagged"
6369644 ],
737355 "type": "string"
8369644}
Responses
codedescriptionhitsavg
20121455ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1591ms
400Bad Request15732ms
500Internal Server Error62ms
Responses
codedescriptionhitsavg
2001731ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3381ms
Path Parameters
id3 / 3
#validinvalidschema
11616{
21616 "format": "uuid",
31616 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4167n/a "type": "string"
51616}
Responses
codedescriptionhitsavg
204955ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized481ms
400Bad Request242ms
Path Parameters
id3 / 3
#validinvalidschema
158538{
258538 "format": "uuid",
358538 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4623n/a "type": "string"
558538}
Responses
codedescriptionhitsavg
2004722ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized821ms
400Bad Request692ms
Path Parameters
id3 / 3
#validinvalidschema
163341{
263341 "format": "uuid",
363341 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4674n/a "type": "string"
563341}
Body
application/json21 / 22
WorkflowUpdateDto
155586{
222679 "properties": {
319119 "description": {
4210n/a "nullable": true,
519119 "type": "string"
619119 },
720116 "enabled": {
820116 "type": "boolean"
920116 },
102067 "logging": {
112067 "type": "boolean"
122067 },
1318519 "name": {
14204n/a "nullable": true,
1518519 "type": "string"
1618519 },
1716936 "steps": {
1816931 "items": {
2016931 },
212005 "type": "array"
2216936 },
2319311 "trigger": {
2519311 }
2622679 },
276347 "type": "object"
2855586}
Referenced Components (2)13 of 14 keywords
WorkflowStepDto10 of 11 keywords
151049{
251539 "properties": {
352825 "config": {
4184n/a "additionalProperties": {},
5553n/a "nullable": true,
60n/a "propertyNames": {
70n/a "type": "string"
80n/a },
952825 "type": "object"
1052825 },
112766 "enabled": {
122766 "type": "boolean"
132766 },
1453416 "method": {
1553416 "type": "string"
1653416 }
1751539 },
185495 "required": [
195504 "method",
205531 "config"
215495 ],
225545 "type": "object"
2351049}
WorkflowTrigger3 of 3 keywords
119311{
219311 "enum": [
3112n/a "AssetCreate",
436n/a "AssetMetadataExtraction",
545n/a "AssetTagged"
619311 ],
71995 "type": "string"
819311}
Responses
codedescriptionhitsavg
2004194ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized301ms
400Bad Request2252ms
Path Parameters
id3 / 3
#validinvalidschema
168020{
268020 "format": "uuid",
368020 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4700n/a "type": "string"
568020}
Query Parameters
result2 / 2
WorkflowResult
116340{
216340 "enum": [
372n/a "completed",
450n/a "halted",
541n/a "error"
616340 ],
7203n/a "type": "string"
816340}
before3 / 3
125543{
225543 "format": "date-time",
325741 "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
4298n/a "type": "string"
525543}
limit4 / 4
117439{
217710 "exclusiveMinimum": true,
31843 "maximum": 9007199254740991,
417710 "minimum": 0,
518726 "type": "integer"
617439}
Responses
codedescriptionhitsavg
2005162ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1342ms
401Unauthorized501ms
Examples
Query
"2024-01-01T00:00:00.000Z"before
50limit
Path Parameters
id3 / 3
#validinvalidschema
162230{
262230 "format": "uuid",
362230 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
4652n/a "type": "string"
562230}
Responses
codedescriptionhitsavg
2005262ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized631ms
400Bad Request632ms
867 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
DELETE0.0.0.0:36907/api/activitiesmethod not documented1
DELETE0.0.0.0:36907/api/activities/statisticsmethod not documented1
DELETE0.0.0.0:36907/api/admin/auth/unlink-allmethod not documented1
DELETE0.0.0.0:36907/api/admin/configmethod not documented1
DELETE0.0.0.0:36907/api/admin/config/defaultsmethod not documented1
DELETE0.0.0.0:36907/api/admin/database-backups/start-restoremethod not documented1
DELETE0.0.0.0:36907/api/admin/database-backups/uploadmethod not documented1
DELETE0.0.0.0:36907/api/admin/database-backups/{filename}method not documented1
DELETE0.0.0.0:36907/api/admin/integrity/reportmethod not documented1
DELETE0.0.0.0:36907/api/admin/integrity/report/{id}/filemethod not documented1

... and 857 more groups