Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Success
The below example shows the status response 200.
{
"data": [
{
"id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"version_number": 1.0,
"base_version_number": 0.0,
"version_code_name": "v1",
"is_main_version": true,
"is_beta": false,
"is_public": true,
"is_deprecated": false,
"created_at": "2024-06-13T02:30:00Z",
"modified_at": "0001-01-01",
"language_versions": [
{
"id": "",
"name": null,
"code": "SS",
"set_as_default": false,
"hidden": false,
"enable_rtl": true,
"site_protection_level": 2,
"is_inheritance_disabled": false,
"has_inheritance_disabled_categories_or_articles": false,
"country_flag_code": null,
"is_home_page_enabled": false,
"version_display_name": null
}
],
"slug": "",
"order": 0,
"version_type": 0
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
The ID of the project version
Project version number
The version number from which this version is derived
Custom version name
"True" if this version is the main version after loading documentation
"True" if this version is marked as Beta
"True" if this version is visible to the public
"True" if this version is marked as deprecated
The date and time the version was created
The last date and time the version was modified
0 - KB workspace , 1 - API Reference workspace
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information