Retrieves a list of users
URL : /api/users
Method : GET
Auth required : YES
Limit: None
Code : 200 OK
Content examples
Example response:
[
    {
        id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
        email: "[email protected]",
        name: "Jim Smith",
        enabled: true,
        admin: true,
        owner: true,
        createdAt: 2022-06-12T06:50:00.021Z,
        updatedAt: 2022-06-12T06:50:00.021Z
    }
]
Search an article using a keyword
URL : /api/user/:id
Method : GET
Auth required : YES
Limit: Single user
Code : 200 OK
Content examples
Example response:
{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "[email protected]",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}
Updates a given user
URL : /api/user/save
Method : PUT
Auth required : NO
Limit: Single user
Code : 200 OK
Content examples
Example request:
{
    id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
    email: "[email protected]",
    name: "Jim Smith",
    enabled: true,
    admin: true
}
Example response:
{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "[email protected]",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}
Inserts a new user
URL : /api/user/insert
Method : PUT
Auth required : YES
Limit: None
Code : 200 OK
Content examples
Example request:
{
    email: "[email protected]",
    name: "Jim Smith"
}
Example response:
{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "[email protected]",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}
Deletes an existing article content
URL : /api/user/delete/:id
Method : DELETE
Auth required : YES
Limit: None
Code : 200 OK
Content examples
Example response:
{
    "success"
}
Retrieve a single article using the article Url
URL : /api/article/:articleurl
Method : GET
Auth required : NO
Limit: Single article
Code : 200 OK
Content examples
An example response:
{
    id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
    url: "hello-world",
    title: "Hello world",
    content: "--- content ---",
    published: true,
    category: "General",
    pinned: true,
    publishedDate: "2022-06-10T10:50:29.062Z",
    views: 7,
    createdAt: 2022-06-12T06:50:13.724Z,
    updatedAt: 2022-06-16T11:09:09.259Z
}
Search an article using a keyword
URL : /api/search/:searchparam
Method : GET
Auth required : NO
Limit: 10 articles
Code : 200 OK
Content examples
An example response:
[
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
        url: "hello-world",
        title: "Hello world",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8c",
        url: "hello-world-two",
        title: "Hello world two",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]
Gets a list of recent articles
URL : /api/search/count/:num
Method : GET
Auth required : NO
Limit: Number supplied in parameter. Cannot exceeedt the ARTICLE_LIMIT_RETURNED environment variable.
Code : 200 OK
Content examples
An example response:
[
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
        url: "hello-world",
        title: "Hello world",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8c",
        url: "hello-world-two",
        title: "Hello world two",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]
Inserts a new article
URL : /api/article/insert
Method : PUT
Auth required : YES
Limit: None
Code : 200 OK
Content examples
Example request:
{
    content: "--- content ---"
}
Example response:
{
    articleId: "b27e97f5-67e7-4883-9402-c7686da28f8b"
}
Updates an existing article content
URL : /api/article/save
Method : PUT
Auth required : YES
Limit: None
Code : 200 OK
Content examples
Example request:
{
    content: "--- content ---",
    id: "b27e97f5-67e7-4883-9402-c7686da28f8c"
}
Example response:
{
    id: "b27e97f5-67e7-4883-9402-c7686da28f8c",
    url: "hello-world-two",
    title: "Hello world two",
    content: "--- content ---",
    published: true,
    category: "General",
    pinned: true,
    publishedDate: "2022-06-10T10:50:29.062Z",
    views: 7,
    createdAt: 2022-06-12T06:50:13.724Z,
    updatedAt: 2022-06-16T11:09:09.259Z
}
Deletes an existing article
URL : /api/article/delete/:id
Method : DELETE
Auth required : YES
Limit: None
Code : 200 OK
Content examples
Example response:
{
    "success"
}
Gets the articles in a given category
URL : /api/category/:category
Method : GET
Auth required : NO
Limit: None
Code : 200 OK
Content examples
Example response:
[
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
        url: "hello-world",
        title: "Hello world",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8c",
        url: "hello-world-two",
        title: "Hello world two",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]
Gets an array of available categories
URL : /api/categories
Method : GET
Auth required : NO
Limit: None
Code : 200 OK
Content examples
Example response:
[
    { category: "Configuration", count: "2" },
    { category: "General", count: "1" },
    { category: "Getting started", count: "1" }
]
helpkb API endpoint documentation below:
A helpkb instance which has guides and support articles: