Skip to content

Commit ddcfb78

Browse files
petar-i-todorovCopilot
petar-i-todorov
and
Copilot
authored
docs: add info about configuration endpoint and deprecate version (#1695)
* docs: add info about configuration endpoint and deprecate version * docs: fix typo * Update embedding-reports/host-the-report-engine-remotely/rest-api-reference/general-api/get-configuration.md Co-authored-by: Copilot <[email protected]> * Update embedding-reports/host-the-report-engine-remotely/rest-api-reference/overview.md Co-authored-by: Copilot <[email protected]> * Update embedding-reports/host-the-report-engine-remotely/rest-api-reference/general-api/get-version.md Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent 3d4a834 commit ddcfb78

File tree

3 files changed

+65
-2
lines changed

3 files changed

+65
-2
lines changed

‎embedding-reports/host-the-report-engine-remotely/rest-api-reference/general-api/get-configuration.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Get Configuration
3+
page_title: Get Configuration Request Explained
4+
description: "Learn how to make the Get Configuration request to the Telerik Reporting REST Service and what response to expect."
5+
slug: telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/general-api/get-configuration
6+
tags: get,configuration
7+
published: True
8+
position: 1
9+
---
10+
11+
# `Get Configuration` Overview
12+
13+
The public interface for retrieving Telerik Reporting REST Service configuration information, including details about version, license status, and available functionality, such as [AI-powered insights]({%slug telerikreporting/designing-reports/adding-interactivity-to-reports/ai-powered-insights%}).
14+
15+
## Request
16+
17+
GET /api/reports/configuration
18+
19+
## Response
20+
21+
| HTTP Status Code | Description |
22+
| ------ | ------ |
23+
|`200 OK`|The configuration of the Telerik Reporting REST Service is retrieved successfully.|
24+
25+
__Response Body__
26+
27+
A configuration object that includes details about version, license status, and available functionality, such as [AI-powered insights]({%slug telerikreporting/designing-reports/adding-interactivity-to-reports/ai-powered-insights%}).
28+
29+
## Sample
30+
31+
* Request
32+
33+
GET /api/reports/configuration HTTP/1.1
34+
35+
* Response
36+
37+
HTTP/1.1 200 OK
38+
39+
{
40+
"version": "{{site.buildversion}}",
41+
"license": {
42+
"type": 2,
43+
"isValid": true,
44+
"title": null,
45+
"message": null,
46+
"messageIcon": 0,
47+
"statusCode": null,
48+
"actionLink": null,
49+
"actionMessage": null,
50+
"expiration": "2026-01-01T05:00:00"
51+
},
52+
"options": [
53+
{
54+
"name": "ai-insights",
55+
"requireConsent": false,
56+
"allowCustomPrompts": false,
57+
"isAvailable": false
58+
}
59+
]
60+
}

‎embedding-reports/host-the-report-engine-remotely/rest-api-reference/general-api/get-version.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@ description: "Learn how to make the Get Version request to the Telerik Reporting
55
slug: telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/general-api/get-version
66
tags: get,version
77
published: True
8-
position: 1
8+
position: 2
99
previous_url: /embedding-reports/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/general-api/get-version, /embedding-reports/host-the-report-engine-remotely/rest-api-reference/general-api/
1010
---
1111

1212
# `Get Version` Overview
1313

1414
The public interface for retrieving the Telerik Reporting REST Service version.
1515

16+
>caution Starting with release 2025 Q2 (version 19.1.25.521), the `Get Version` endpoint has been marked as obsolete. To retrieve the version of the Telerik Reporting REST Service, use the [Get Configuration endpoint]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/general-api/get-configuration%}) instead.
17+
1618
## Request
1719

1820
GET /api/reports/version

‎embedding-reports/host-the-report-engine-remotely/rest-api-reference/overview.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,5 @@ The API represents resources as hierarchical URIs to force the clients to use ce
5353
| [Search in a Document]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/documents-api/search-in-a-document%})|POST|/api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}/search|
5454
| [Release Document]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/documents-api/release-document%})|DELETE|/api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}|
5555
| [Get Available Document Formats]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/general-api/get-available-document-formats%})|GET|/api/reports/formats|
56-
| [Get Version]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/general-api/get-version%})|GET|/api/reports/version|
56+
| [Get Version (Deprecated)]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/general-api/get-version%})|GET|/api/reports/version|
57+
| [Get Configuration]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/general-api/get-configuration%})|GET|/api/reports/configuration|

0 commit comments

Comments
 (0)