mirror of
https://github.com/Tautulli/Tautulli.git
synced 2025-07-06 05:01:14 -07:00
Update API docs with all delete function changes
This commit is contained in:
parent
440adfb914
commit
4de7884e39
1 changed files with 35 additions and 11 deletions
46
API.md
46
API.md
|
@ -88,7 +88,8 @@ Required parameters:
|
||||||
section_id (str): The id of the Plex library section
|
section_id (str): The id of the Plex library section
|
||||||
|
|
||||||
Optional parameters:
|
Optional parameters:
|
||||||
None
|
server_id (str): The Plex server identifier of the library section
|
||||||
|
row_ids (str): Comma separated row ids to delete, e.g. "2,3,8"
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
None
|
None
|
||||||
|
@ -103,7 +104,7 @@ Required parameters:
|
||||||
user_id (str): The id of the Plex user
|
user_id (str): The id of the Plex user
|
||||||
|
|
||||||
Optional parameters:
|
Optional parameters:
|
||||||
None
|
row_ids (str): Comma separated row ids to delete, e.g. "2,3,8"
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
None
|
None
|
||||||
|
@ -114,6 +115,21 @@ Returns:
|
||||||
Delete and recreate the cache directory.
|
Delete and recreate the cache directory.
|
||||||
|
|
||||||
|
|
||||||
|
### delete_history
|
||||||
|
Delete history rows from Tautulli.
|
||||||
|
|
||||||
|
```
|
||||||
|
Required parameters:
|
||||||
|
row_ids (str): Comma separated row ids to delete, e.g. "65,110,2,3645"
|
||||||
|
|
||||||
|
Optional parameters:
|
||||||
|
None
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
None
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### delete_hosted_images
|
### delete_hosted_images
|
||||||
Delete the images uploaded to image hosting services.
|
Delete the images uploaded to image hosting services.
|
||||||
|
|
||||||
|
@ -146,7 +162,8 @@ Required parameters:
|
||||||
section_id (str): The id of the Plex library section
|
section_id (str): The id of the Plex library section
|
||||||
|
|
||||||
Optional parameters:
|
Optional parameters:
|
||||||
None
|
server_id (str): The Plex server identifier of the library section
|
||||||
|
row_ids (str): Comma separated row ids to delete, e.g. "2,3,8"
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
None
|
None
|
||||||
|
@ -294,7 +311,7 @@ Required parameters:
|
||||||
user_id (str): The id of the Plex user
|
user_id (str): The id of the Plex user
|
||||||
|
|
||||||
Optional parameters:
|
Optional parameters:
|
||||||
None
|
row_ids (str): Comma separated row ids to delete, e.g. "2,3,8"
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
None
|
None
|
||||||
|
@ -726,7 +743,6 @@ Returns:
|
||||||
"group_count": 1,
|
"group_count": 1,
|
||||||
"group_ids": "1124",
|
"group_ids": "1124",
|
||||||
"guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en",
|
"guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en",
|
||||||
"id": 1124,
|
|
||||||
"ip_address": "xxx.xxx.xxx.xxx",
|
"ip_address": "xxx.xxx.xxx.xxx",
|
||||||
"live": 0,
|
"live": 0,
|
||||||
"media_index": 17,
|
"media_index": 17,
|
||||||
|
@ -742,6 +758,7 @@ Returns:
|
||||||
"player": "Castle-PC",
|
"player": "Castle-PC",
|
||||||
"rating_key": 4348,
|
"rating_key": 4348,
|
||||||
"reference_id": 1123,
|
"reference_id": 1123,
|
||||||
|
"row_id": 1124,
|
||||||
"session_key": null,
|
"session_key": null,
|
||||||
"started": 1462688107,
|
"started": 1462688107,
|
||||||
"state": null,
|
"state": null,
|
||||||
|
@ -895,7 +912,7 @@ Returns:
|
||||||
"do_notify_created": "Checked",
|
"do_notify_created": "Checked",
|
||||||
"duration": 1578037,
|
"duration": 1578037,
|
||||||
"guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en",
|
"guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en",
|
||||||
"id": 1128,
|
"histroy_row_id": 1128,
|
||||||
"is_active": 1,
|
"is_active": 1,
|
||||||
"keep_history": "Checked",
|
"keep_history": "Checked",
|
||||||
"labels": [],
|
"labels": [],
|
||||||
|
@ -912,9 +929,11 @@ Returns:
|
||||||
"parent_title": "",
|
"parent_title": "",
|
||||||
"plays": 772,
|
"plays": 772,
|
||||||
"rating_key": 153037,
|
"rating_key": 153037,
|
||||||
|
"row_id": 1,
|
||||||
"section_id": 2,
|
"section_id": 2,
|
||||||
"section_name": "TV Shows",
|
"section_name": "TV Shows",
|
||||||
"section_type": "Show",
|
"section_type": "Show",
|
||||||
|
"server_id": "ds48g4r354a8v9byrrtr697g3g79w",
|
||||||
"thumb": "/library/metadata/153036/thumb/1462175062",
|
"thumb": "/library/metadata/153036/thumb/1462175062",
|
||||||
"year": 2016
|
"year": 2016
|
||||||
},
|
},
|
||||||
|
@ -947,9 +966,11 @@ Returns:
|
||||||
"library_art": "/:/resources/movie-fanart.jpg",
|
"library_art": "/:/resources/movie-fanart.jpg",
|
||||||
"library_thumb": "/:/resources/movie.png",
|
"library_thumb": "/:/resources/movie.png",
|
||||||
"parent_count": null,
|
"parent_count": null,
|
||||||
|
"row_id": 1,
|
||||||
"section_id": 1,
|
"section_id": 1,
|
||||||
"section_name": "Movies",
|
"section_name": "Movies",
|
||||||
"section_type": "movie"
|
"section_type": "movie",
|
||||||
|
"server_id": "ds48g4r354a8v9byrrtr697g3g79w"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -1065,11 +1086,11 @@ Get a library's watch time statistics.
|
||||||
|
|
||||||
```
|
```
|
||||||
Required parameters:
|
Required parameters:
|
||||||
section_id (str): The id of the Plex library section
|
section_id (str): The id of the Plex library section
|
||||||
|
|
||||||
Optional parameters:
|
Optional parameters:
|
||||||
grouping (int): 0 or 1
|
grouping (int): 0 or 1
|
||||||
query_days (str): Comma separated days, e.g. "1, 7, 30, 0"
|
query_days (str): Comma separated days, e.g. "1,7,30,0"
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
json:
|
json:
|
||||||
|
@ -2232,6 +2253,7 @@ Returns:
|
||||||
"is_home_user": 1,
|
"is_home_user": 1,
|
||||||
"is_restricted": 0,
|
"is_restricted": 0,
|
||||||
"keep_history": 1,
|
"keep_history": 1,
|
||||||
|
"row_id": 1,
|
||||||
"shared_libraries": ["10", "1", "4", "5", "15", "20", "2"],
|
"shared_libraries": ["10", "1", "4", "5", "15", "20", "2"],
|
||||||
"user_id": 133788,
|
"user_id": 133788,
|
||||||
"user_thumb": "https://plex.tv/users/k10w42309cynaopq/avatar",
|
"user_thumb": "https://plex.tv/users/k10w42309cynaopq/avatar",
|
||||||
|
@ -2384,7 +2406,7 @@ Required parameters:
|
||||||
|
|
||||||
Optional parameters:
|
Optional parameters:
|
||||||
grouping (int): 0 or 1
|
grouping (int): 0 or 1
|
||||||
query_days (str): Comma separated days, e.g. "1, 7, 30, 0"
|
query_days (str): Comma separated days, e.g. "1,7,30,0"
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
json:
|
json:
|
||||||
|
@ -2434,6 +2456,7 @@ Returns:
|
||||||
"is_home_user": 1,
|
"is_home_user": 1,
|
||||||
"is_restricted": 0,
|
"is_restricted": 0,
|
||||||
"keep_history": 1,
|
"keep_history": 1,
|
||||||
|
"row_id": 1,
|
||||||
"server_token": "PU9cMuQZxJKFBtGqHk68",
|
"server_token": "PU9cMuQZxJKFBtGqHk68",
|
||||||
"shared_libraries": "1;2;3",
|
"shared_libraries": "1;2;3",
|
||||||
"thumb": "https://plex.tv/users/k10w42309cynaopq/avatar",
|
"thumb": "https://plex.tv/users/k10w42309cynaopq/avatar",
|
||||||
|
@ -2473,7 +2496,7 @@ Returns:
|
||||||
"duration": 2998290,
|
"duration": 2998290,
|
||||||
"friendly_name": "Jon Snow",
|
"friendly_name": "Jon Snow",
|
||||||
"guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en",
|
"guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en",
|
||||||
"id": 1121,
|
"history_row_id": 1121,
|
||||||
"ip_address": "xxx.xxx.xxx.xxx",
|
"ip_address": "xxx.xxx.xxx.xxx",
|
||||||
"is_active": 1,
|
"is_active": 1,
|
||||||
"keep_history": "Checked",
|
"keep_history": "Checked",
|
||||||
|
@ -2489,6 +2512,7 @@ Returns:
|
||||||
"player": "Plex Web (Chrome)",
|
"player": "Plex Web (Chrome)",
|
||||||
"plays": 487,
|
"plays": 487,
|
||||||
"rating_key": 153037,
|
"rating_key": 153037,
|
||||||
|
"row_id": 1,
|
||||||
"thumb": "/library/metadata/153036/thumb/1462175062",
|
"thumb": "/library/metadata/153036/thumb/1462175062",
|
||||||
"transcode_decision": "transcode",
|
"transcode_decision": "transcode",
|
||||||
"user_id": 133788,
|
"user_id": 133788,
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue