Skip to content

Commit 04581eb

Browse files
BurntimeXBurntimeX
committed
Document available RPC endpoints
Closes #444
1 parent 66d788a commit 04581eb

File tree

2 files changed

+177
-1
lines changed

2 files changed

+177
-1
lines changed

‎docs/php/api/rpc_api_endpoints.md‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
# RPC Endpoints
2+
3+
| Name | Type | Route | Description |
4+
| ---- | ----- | ----- | ----------- |
5+
| DeleteBlog | Delete | /blog/blogs/{id:\d+} | Deletes the blog with the given ID. |
6+
| SetBlogAsFeatured | Post | /blog/blogs/{id:\d+}/set-as-featured | Flags the blog with the given ID as featured. |
7+
| UnsetBlogAsFeatured | Post | /blog/blogs/{id:\d+}/unset-as-featured | Deflags the blog with the given ID as featured. |
8+
| DeleteEntry | Delete | /blog/entries/{id:\d+} | Deletes the blog entry with the given ID. |
9+
| GetEntryContentHeaderTitle | Get | /blog/entries/{id:\d+}/content-header-title | Retrieves the HTML code for the content header title of the blog entry with the given ID. |
10+
| DisableEntry | Post | /blog/entries/{id:\d+}/disable | Disables the blog entry with the given ID. |
11+
| EnableEntry | Post | /blog/entries/{id:\d+}/enable | Enables the blog entry with the given ID. |
12+
| GetEntryPopover | Get | /blog/entries/{id:\d+}/popover | Retrieves the HTML code for the popover of the blog entry with the given ID. |
13+
| RestoreEntry | Post | /blog/entries/{id:\d+}/restore | Restores a soft-deleted blog entry with the given ID. |
14+
| SetEntryAsFeatured | Post | /blog/entries/{id:\d+}/set-as-featured | Flags the blog entry with the given ID as featured. |
15+
| SoftDeleteEntry | Post | /blog/entries/{id:\d+}/soft-delete | Soft-deletes the blog entry with the given ID. |
16+
| UnsetEntryAsFeatured | Post | /blog/entries/{id:\d+}/unset-as-featured | Deflags the blog entry with the given ID as featured. |
17+
| GetEventDateOverlap | Get | /calendar/events/dates/overlap | Retrieves the HTML code for showing overlapping calendar events. |
18+
| GetEventDatePopover | Get | /calendar/events/dates/{id:\d+}/popover | Retrieves the HTML code for the popover of the calendar event with the given ID. |
19+
| DeleteImport | Delete | /calendar/events/imports/{id:\d+} | Deletes the calendar event import with the given ID. |
20+
| DisableImport | Post | /calendar/events/imports/{id:\d+}/disable | Disables the calendar event import with the given ID. |
21+
| EnableImport | Post | /calendar/events/imports/{id:\d+}/enable | Enables the calendar event import with the given ID. |
22+
| GetShowOrder | Get | /core/ads/show-order | Retrieves the show order of ads. |
23+
| ChangeShowOrder | Post | /core/ads/show-order | Saves the show order of ads. |
24+
| DeleteAd | Delete | /core/ads/{id:\d+} | Deletes the ad with the given ID. |
25+
| DisableAd | Post | /core/ads/{id:\d+}/disable | Disables the blog entry with the given ID. |
26+
| EnableAd | Post | /core/ads/{id:\d+}/enable | Enables the blog entry with the given ID. |
27+
| GetArticleContentHeaderTitle | Get | /core/articles/contents/{id:\d+}/content-header-title | Retrieves the HTML code for the content header title of the article content with the given ID. |
28+
| DeleteArticle | Delete | /core/articles/{id:\d+} | Deletes the article with the given ID. |
29+
| GetArticlePopover | Get | /core/articles/{id:\d+}/popover | Retrieves the HTML code for the popover of the article with the given ID. |
30+
| PublishArticle | Post | /core/articles/{id:\d+}/publish | Publishes the article with the given ID. |
31+
| RestoreArticle | Post | /core/articles/{id:\d+}/restore | Restores the article with the given ID. |
32+
| SoftDeleteArticle | Post | /core/articles/{id:\d+}/soft-delete | Soft-deletes the article with the given ID. |
33+
| UnpublishArticle | Post | /core/articles/{id:\d+}/unpublish | Unpublishes the article with the given ID. |
34+
| ChangeShowOrder | Post | /core/attachments/show-order | Saves the show order of attachments. |
35+
| DeleteAttachment | Delete | /core/attachments/{id:\d+} | Deletes the attachment with the given ID. |
36+
| DeleteProvider | Delete | /core/bbcodes/media/providers/{id:\d+} | Deletes the media provider with the given ID. |
37+
| DisableProvider | Post | /core/bbcodes/media/providers/{id:\d+}/disable | Disables the media provider with the given ID. |
38+
| EnableProvider | Post | /core/bbcodes/media/providers/{id:\d+}/enable | Enables the media provider with the given ID. |
39+
| DeleteBBCodes | Delete | /core/bbcodes/{id:\d+} | Deletes the bbcode with the given ID. |
40+
| DeleteBox | Delete | /core/boxes/{id:\d+} | Enables the media provider with the given ID. |
41+
| DisableBox | Post | /core/boxes/{id:\d+}/disable | Disables the box with the given ID. |
42+
| EnableBox | Post | /core/boxes/{id:\d+}/enable | Enables the box with the given ID. |
43+
| DeleteQuestion | Delete | /core/captchas/questions/{id:\d+} | Deletes the captcha question with the given ID. |
44+
| DisableQuestion | Post | /core/captchas/questions/{id:\d+}/disable | Disables the captcha question with the given ID. |
45+
| EnableQuestion | Post | /core/captchas/questions/{id:\d+}/enable | Enables the captcha question with the given ID. |
46+
| CreateComment | Post | /core/comments | Creates a new comment. |
47+
| RenderComments | Get | /core/comments/render | Retrieves the HTML code for the rendering of a list of comments. |
48+
| CreateResponse | Post | /core/comments/responses | Creates a new comment response. |
49+
| RenderResponses | Get | /core/comments/responses/render | Retrieves the HTML code for the rendering of a list of comment responses. |
50+
| UpdateResponse | Post | /core/comments/responses/{id:\d+} | Updates the comment response with the given ID. |
51+
| DeleteResponse | Delete | /core/comments/responses/{id:\d+} | Deletes the comment response with the given ID. |
52+
| EditResponse | Get | /core/comments/responses/{id:\d+}/edit | Retrieves the HTML code for the editing of the comment response with the given ID. |
53+
| EnableResponse | Post | /core/comments/responses/{id:\d+}/enable | Enables the comment response with the given ID. |
54+
| RenderResponse | Get | /core/comments/responses/{id:\d+}/render | Retrieves the HTML code for the rendering of the comment response with the given ID. |
55+
| DeleteComment | Delete | /core/comments/{id:\d+} | Deletes the comment with the given ID. |
56+
| UpdateComment | Post | /core/comments/{id:\d+} | Updates the comment with the given ID. |
57+
| EditComment | Get | /core/comments/{id:\d+}/edit | Retrieves the HTML code for the editing of the comment with the given ID. |
58+
| EnableComment | Post | /core/comments/{id:\d+}/enable | Enables the comment response with the given ID. |
59+
| RenderComment | Get | /core/comments/{id:\d+}/render | Retrieves the HTML code for the rendering of the comment with the given ID. |
60+
| GetShowOrder | Get | /core/contact/options/show-order | Retrieves the show order of contact options. |
61+
| ChangeShowOrder | Post | /core/contact/options/show-order | Saves the show order of contact options. |
62+
| DeleteOption | Delete | /core/contact/options/{id:\d+} | Deletes the contact option with the given ID. |
63+
| DisableOption | Post | /core/contact/options/{id:\d+}/disable | Disables the contact option with the given ID. |
64+
| EnableOption | Post | /core/contact/options/{id:\d+}/enable | Enables the contact option with the given ID. |
65+
| GetShowOrder | Get | /core/contact/recipients/show-order | Retrieves the show order of contact recipients. |
66+
| ChangeShowOrder | Post | /core/contact/recipients/show-order | Saves the show order of contact recipients. |
67+
| DeleteRecipient | Delete | /core/contact/recipients/{id:\d+} | Deletes the contact recipient with the given ID. |
68+
| DisableRecipient | Post | /core/contact/recipients/{id:\d+}/disable | Disables the contact recipient with the given ID. |
69+
| EnableRecipient | Post | /core/contact/recipients/{id:\d+}/enable | Enables the contact recipient with the given ID. |
70+
| DeleteConversationLabel | Delete | /core/conversations/labels/{id:\d+} | Deletes the conversation label with the given ID. |
71+
| GetConversationParticipantList | Get | /core/conversations/{conversationId:\d+}/participants | Retrieves the HTML code for the list of participants of the conversation with the given ID. |
72+
| RemoveConversationParticipant | Delete | /core/conversations/{conversationId:\d+}/participants/{participantId:\d+} | Removes a participant from the conversation with the given ID. |
73+
| CloseConversation | Post | /core/conversations/{id:\d+}/close | Closes the conversation with the given ID for new messages. |
74+
| GetConversationHeaderTitle | Get | /core/conversations/{id:\d+}/content-header-title | Retrieves the HTML code for the content header title of the conversation with the given ID. |
75+
| LeaveConversation | Post | /core/conversations/{id:\d+}/leave | Leaves the conversation with the given ID. |
76+
| LeavePermanentlyConversation | Post | /core/conversations/{id:\d+}/leave-permanently | Leaves the conversation with the given ID permanently. |
77+
| OpenConversation | Post | /core/conversations/{id:\d+}/open | Opens the conversation with the given ID for new messages. |
78+
| GetConversationPopover | Get | /core/conversations/{id:\d+}/popover | Retrieves the HTML code for the popover of the conversation with the given ID. |
79+
| RestoreConversation | Post | /core/conversations/{id:\d+}/restore | Restores the conversation with the given ID. |
80+
| ClearLogs | Delete | /core/cronjobs/logs | Clears the cronjob log. |
81+
| DeleteCronjob | Delete | /core/cronjobs/{id:\d+} | Deletes the cronjob with the given ID. |
82+
| DisableCronjob | Post | /core/cronjobs/{id:\d+}/disable | Disables the cronjob with the given ID. |
83+
| EnableCronjob | Post | /core/cronjobs/{id:\d+}/enable | Enables the cronjob with the given ID. |
84+
| ExecuteCronjob | Post | /core/cronjobs/{id:\d+}/execute | Executes the cronjob with the given ID. |
85+
| RenderException | Get | /core/exceptions/{id:[a-f0-9]{40}}/render | Retrieves the HTML code for the rendering of the exception log entry with the given ID. |
86+
| PrepareUpload | Post | /core/files/upload | Prepares the upload of a file. |
87+
| SaveChunk | Post | /core/files/upload/{identifier}/chunk/{sequenceNo:\d+} | Reads a chunk of a file upload. |
88+
| GenerateThumbnails | Post | /core/files/{id:\d+}/generate-thumbnails | Generates thumbnails for the file with the given ID. |
89+
| DeleteFile | Delete | /core/files/{id} | Deletes the file with the given ID. |
90+
| GetGridView | Get | /core/grid-views/render | Retrieves the HTML code for the rendering of a grid view in a dialog. |
91+
| GetRow | Get | /core/grid-views/row | Retrieves the HTML code for the rendering of a grid view row. |
92+
| GetRows | Get | /core/grid-views/rows | Retrieves the HTML code for the rendering of a list of grid view rows. |
93+
| GetBulkContextMenuOptions | Post | /core/interactions/bulk-context-menu-options | Retrieves the HTML code for the rendering of a bulk interaction context menu. |
94+
| GetContextMenuOptions | Get | /core/interactions/context-menu-options | Retrieves the HTML code for the rendering of a interaction context menu. |
95+
| GetShowOrder | Get | /core/labels/groups/show-order | Retrieves the show order of label groups. |
96+
| ChangeShowOrder | Post | /core/labels/groups/show-order | Saves the show order of label groups. |
97+
| DeleteGroup | Delete | /core/labels/groups/{id:\d+} | Deletes the label group with the given ID. |
98+
| ChangeLabelShowOrder | Post | /core/labels/groups/{id:\d+}/labels/show-order | Saves the show order of the labels in the group with the given ID. |
99+
| GetLabelShowOrder | Get | /core/labels/groups/{id:\d+}/labels/show-order | Retrieves the show order of the labels in the group with the given ID. |
100+
| DeleteLabel | Delete | /core/labels/{id:\d+} | Deletes the label with the given ID. |
101+
| DeleteItem | Delete | /core/languages/items/{id:\d+} | Deletes the language item with the given ID. |
102+
| DeleteLanguage | Delete | /core/languages/{id:\d+} | Deletes the language with the given ID. |
103+
| SetAsDefaultLanguage | Post | /core/languages/{id:\d+}/default | Flags the language with the given ID as default language. |
104+
| DisableLanguage | Post | /core/languages/{id:\d+}/disable | Disables the language with the given ID. |
105+
| EnableLanguage | Post | /core/languages/{id:\d+}/enable | Enables the language with the given ID. |
106+
| GetItem | Get | /core/list-views/item | Retrieves the HTML code for the rendering of a list view item. |
107+
| GetItems | Get | /core/list-views/items | Retrieves the HTML code for the rendering of a list of list view items. |
108+
| DeleteMenu | Delete | /core/menus/{id:\d+} | Deletes the menu with the given ID. |
109+
| GetMentionSuggestions | Get | /core/messages/mention-suggestions | Retrieves the list of users and groups that can be mentioned. |
110+
| GetMessageAuthor | Get | /core/messages/message-author | Returns information about the author of a quoted message. |
111+
| RenderQuote | Get | /core/messages/render-quote | Retrieves data for the rendering of a quote. |
112+
| ResetRemovalQuotes | Post | /core/messages/reset-removal-quotes | Resets the session variable that stores the information which quotes should be deleted at the next request. |
113+
| ChangeJustifiedStatus | Post | /core/moderation-queues/{id:\d+}/change-justified-status | Changes the justified status of the report with the given ID. |
114+
| CloseReport | Post | /core/moderation-queues/{id:\d+}/close | Closes the report with the given ID by marking it as done without further processing. |
115+
| DeleteContent | Post | /core/moderation-queues/{id:\d+}/delete-content | Deletes the content associated with the moderation queue entry with the given ID. |
116+
| EnableContent | Post | /core/moderation-queues/{id:\d+}/enable-content | Enables the content associated with the moderation queue entry with the given ID. |
117+
| MarkAsRead | Post | /core/moderation-queues/{id:\d+}/mark-as-read | Marks the moderation queue entry with the given ID as read. |
118+
| GetShowOrder | Get | /core/notices/show-order | Retrieves the show order of user notices. |
119+
| ChangeShowOrder | Post | /core/notices/show-order | Saves the show order of user notices. |
120+
| DeleteNotice | Delete | /core/notices/{id:\d+} | Deletes the user notices with the given ID. |
121+
| DisableNotice | Post | /core/notices/{id:\d+}/disable | Disables the user notices with the given ID. |
122+
| EnableNotice | Post | /core/notices/{id:\d+}/enable | Enables the user notices with the given ID. |
123+
| DeleteServer | Delete | /core/packages/updates/servers/{id} | Deletes the package update server with the given ID. |
124+
| DisableServer | Post | /core/packages/updates/servers/{id}/disable | Disables the package update server with the given ID. |
125+
| EnableServer | Post | /core/packages/updates/servers/{id}/enable | Enables the package update server with the given ID. |
126+
| DeletePage | Delete | /core/pages/{id:\d+} | Deletes the page with the given ID. |
127+
| DisablePage | Post | /core/pages/{id:\d+}/disable | Disables the page with the given ID. |
128+
| EnablePage | Post | /core/pages/{id:\d+}/enable | Enables the page with the given ID. |
129+
| DeleteSubscriptionUser | Delete | /core/paid/subscriptions/users/{id:\d+} | Deletes the paid subscription user with the given ID. |
130+
| DeleteSubscription | Delete | /core/paid/subscriptions/{id:\d+} | Deletes the paid subscription with the given ID. |
131+
| DisableSubscription | Post | /core/paid/subscriptions/{id:\d+}/disable | Disables the paid subscription with the given ID. |
132+
| EnableSubscription | Post | /core/paid/subscriptions/{id:\d+}/enable | Enables the paid subscription with the given ID. |
133+
| GetShowOrder | Get | /core/reactions/types/show-order | Retrieves the show order of reaction types. |
134+
| ChangeShowOrder | Post | /core/reactions/types/show-order | Saves the show order of reaction types. |
135+
| DeleteType | Delete | /core/reactions/types/{id:\d+} | Deletes the reaction type with the given ID. |
136+
| DisableType | Post | /core/reactions/types/{id:\d+}/disable | Disables the reaction type with the given ID. |
137+
| EnableType | Post | /core/reactions/types/{id:\d+}/enable | Enables the reaction type with the given ID. |
138+
| DeleteSession | Delete | /core/sessions/{id} | Deletes one of the current user’s sessions, causing a device with that session id to be logged out. |
139+
| GetSmileyShowOrder | Get | /core/smilies/categories/{id:\d+}/show-order | Retrieves the show order of smilies in the category with the given ID. |
140+
| ChangeSmileyShowOrder | Post | /core/smilies/categories/{id:\d+}/show-order | Saves the show order of smilies in the category with the given ID. |
141+
| GetShowOrder | Get | /core/smilies/show-order | Retrieves the show order of smilies. |
142+
| ChangeShowOrder | Post | /core/smilies/show-order | Saves the show order of smilies. |
143+
| DeleteSmiley | Delete | /core/smilies/{id:\d+} | Deletes the smiley with the given ID. |
144+
| DeleteStyle | Delete | /core/styles/{id:\d+} | Deletes the style with the given ID. |
145+
| AddDarkMode | Post | /core/styles/{id:\d+}/add-dark-mode | Adds a dark mode to the style with the given ID. |
146+
| CopyStyle | Post | /core/styles/{id:\d+}/copy | Copies the style with the given ID. |
147+
| DisableStyle | Post | /core/styles/{id:\d+}/disable | Disables the style with the given ID. |
148+
| EnableStyle | Post | /core/styles/{id:\d+}/enable | Enables the style with the given ID. |
149+
| SetStyleAsDefault | Post | /core/styles/{id:\d+}/set-as-default | Flags the style with the given ID as default style. |
150+
| DeleteTag | Delete | /core/tags/{id:\d+} | Deletes the tag with the given ID. |
151+
| DeleteTemplateGroup | Delete | /core/templates/groups/{id:\d+} | Deletes the template group with the given ID. |
152+
| DeleteTemplate | Delete | /core/templates/{id:\d+} | Deletes the template with the given ID. |
153+
| GetShowOrder | Get | /core/trophies/show-order | Retrieves the show order of trophies. |
154+
| ChangeShowOrder | Post | /core/trophies/show-order | Saves the show order of trophies. |
155+
| DeleteTrophy | Delete | /core/trophies/{id:\d+} | Deletes the trophy with the given ID. |
156+
| DisableTrophy | Post | /core/trophies/{id:\d+}/disable | Disables the trophy with the given ID. |
157+
| EnableTrophy | Post | /core/trophies/{id:\d+}/enable | Enables the trophy with the given ID. |
158+
| DeleteAssignment | Delete | /core/users/groups/assignments/{id:\d+} | Deletes the trophy with the given ID. API endpoint for deleting user group assignments. |
159+
| DisableAssignment | Post | /core/users/groups/assignments/{id:\d+}/disable | Disables the user group assignments with the given ID. |
160+
| EnableAssignment | Post | /core/users/groups/assignments/{id:\d+}/enable | Enables the user group assignments with the given ID. |
161+
| DeleteGroup | Delete | /core/users/groups/{id:\d+} | Deletes the user group with the given ID. |
162+
| DeleteOption | Delete | /core/users/options/{id:\d+} | Deletes the user option with the given ID. |
163+
| DisableOption | Post | /core/users/options/{id:\d+}/disable | Disables the user option with the given ID. |
164+
| EnableOption | Post | /core/users/options/{id:\d+}/enable | Enables the user option with the given ID. |
165+
| DeleteUserRank | Delete | /core/users/ranks/{id:\d+} | Deletes the user rank with the given ID. |
166+
| DeleteUserTrophy | Delete | /core/users/trophies/{id:\d+} | Deletes the user trophy with the given ID. |
167+
| RevertVersion | Post | /core/version-trackers/revert | Reverts a version tracker object to a previous version. |
168+
| GetFilePopover | Get | /filebase/files/{id:\d+}/popover | Retrieves the HTML code for the popover of the filebase file with the given ID. |
169+
| DeleteLicense | Delete | /filebase/licenses/{id:\d+} | Deletes the filebase license with the given ID. |
170+
| GetPostPopover | Get | /forum/posts/{id:\d+}/popover | Retrieves the HTML code for the popover of the forum post with the given ID. |
171+
| DeleteFeed | Delete | /forum/rss/feeds/{id:\d+} | Deletes the RSS feed with the given ID. |
172+
| DisableFeed | Post | /forum/rss/feeds/{id:\d+}/disable | Disables the RSS feed with the given ID. |
173+
| EnableFeed | Post | /forum/rss/feeds/{id:\d+}/enable | Enables the RSS feed with the given ID. |
174+
| GetThreadPopover | Get | /forum/threads/{id:\d+}/popover | Retrieves the HTML code for the popover of the forum thread with the given ID. |

0 commit comments

Comments
 (0)