Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Knowledgebase endpoints (Client API: account)

5 FeatherPanel Client API: account endpoints from user/knowledgebase.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

Defined in backend/app/routes/user/knowledgebase.php. Authentication used here: Signed-in user. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

Endpoints

GET/api/user/knowledgebase/categories

Auth: Signed-in userDefault rate limit: 60 / minute (user-knowledgebase)Route name: user-knowledgebase-categoriesController: KnowledgebaseController::categoriesIndexroute source
curl -X GET "$PANEL_URL/api/user/knowledgebase/categories" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:user:knowledgebase:categories:retrieved

GET/api/user/knowledgebase/categories/{id}

Auth: Signed-in userDefault rate limit: 60 / minute (user-knowledgebase)Route name: user-knowledgebase-categories-showController: KnowledgebaseController::categoriesShowroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X GET "$PANEL_URL/api/user/knowledgebase/categories/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:user:knowledgebase:category:retrieved

GET/api/user/knowledgebase/articles

Auth: Signed-in userDefault rate limit: 60 / minute (user-knowledgebase)Route name: user-knowledgebase-articlesController: KnowledgebaseController::articlesIndexroute source
curl -X GET "$PANEL_URL/api/user/knowledgebase/articles" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:user:knowledgebase:articles:retrieved

GET/api/user/knowledgebase/articles/{id}

Auth: Signed-in userDefault rate limit: 60 / minute (user-knowledgebase)Route name: user-knowledgebase-articles-showController: KnowledgebaseController::articlesShowroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X GET "$PANEL_URL/api/user/knowledgebase/articles/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:user:knowledgebase:article:retrieved

GET/api/user/knowledgebase/categories/{id}/articles

Auth: Signed-in userDefault rate limit: 60 / minute (user-knowledgebase)Route name: user-knowledgebase-categories-articlesController: KnowledgebaseController::categoryArticlesroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X GET "$PANEL_URL/api/user/knowledgebase/categories/$ID/articles" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:user:knowledgebase:category:articles:retrieved

Written from the source:FeatherPanel/backend/app/routes/user/knowledgebase.php
View source on GitHubReport a problemLast updated