|
3 | 3 | """ |
4 | 4 | STACKIT Audit Log API |
5 | 5 |
|
6 | | - API Endpoints to retrieve recorded actions and resulting changes in the system. ### Documentation The user documentation with explanations how to use the api can be found [here](https://docs.stackit.cloud/stackit/en/retrieve-audit-log-per-api-request-134415907.html). ### Audit Logging Changes on organizations, folders and projects and respective cloud resources are logged and collected in the audit log. ### API Constraints The audit log API allows to download messages from the last 90 days. The maximum duration that can be queried at once is 24 hours. Requests are rate limited - the current maximum is 60 requests per minute. |
| 6 | + **Deprecated:** The auditlog API is deprecated and will be removed shortly. Please use the [telemetry-router](https://docs.stackit.cloud/products/logging-and-monitoring/telemetry-router/) to retrieve audit log messages in the future. |
7 | 7 |
|
8 | 8 | The version of the OpenAPI document: 2.0 |
9 | 9 | Generated by OpenAPI Generator (https://openapi-generator.tech) |
10 | 10 |
|
11 | 11 | Do not edit the class manually. |
12 | 12 | """ # noqa: E501 |
13 | 13 |
|
| 14 | +import warnings |
14 | 15 | from datetime import datetime |
15 | 16 | from typing import Any, Dict, List, Optional, Tuple, Union |
16 | 17 | from uuid import UUID |
@@ -82,7 +83,7 @@ def list_folder_audit_log_entries( |
82 | 83 | _headers: Optional[Dict[StrictStr, Any]] = None, |
83 | 84 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
84 | 85 | ) -> ListAuditLogEntriesResponse: |
85 | | - """Folder - Download audit log entries |
| 86 | + """(Deprecated) Folder - Download audit log entries |
86 | 87 |
|
87 | 88 | Returns all audit log entries of the folder for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
88 | 89 |
|
@@ -117,6 +118,7 @@ def list_folder_audit_log_entries( |
117 | 118 | :type _host_index: int, optional |
118 | 119 | :return: Returns the result object. |
119 | 120 | """ # noqa: E501 |
| 121 | + warnings.warn("GET /v2/folders/{folderId} is deprecated.", DeprecationWarning) |
120 | 122 |
|
121 | 123 | _param = self._list_folder_audit_log_entries_serialize( |
122 | 124 | folder_id=folder_id, |
@@ -186,7 +188,7 @@ def list_folder_audit_log_entries_with_http_info( |
186 | 188 | _headers: Optional[Dict[StrictStr, Any]] = None, |
187 | 189 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
188 | 190 | ) -> ApiResponse[ListAuditLogEntriesResponse]: |
189 | | - """Folder - Download audit log entries |
| 191 | + """(Deprecated) Folder - Download audit log entries |
190 | 192 |
|
191 | 193 | Returns all audit log entries of the folder for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
192 | 194 |
|
@@ -221,6 +223,7 @@ def list_folder_audit_log_entries_with_http_info( |
221 | 223 | :type _host_index: int, optional |
222 | 224 | :return: Returns the result object. |
223 | 225 | """ # noqa: E501 |
| 226 | + warnings.warn("GET /v2/folders/{folderId} is deprecated.", DeprecationWarning) |
224 | 227 |
|
225 | 228 | _param = self._list_folder_audit_log_entries_serialize( |
226 | 229 | folder_id=folder_id, |
@@ -290,7 +293,7 @@ def list_folder_audit_log_entries_without_preload_content( |
290 | 293 | _headers: Optional[Dict[StrictStr, Any]] = None, |
291 | 294 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
292 | 295 | ) -> RESTResponseType: |
293 | | - """Folder - Download audit log entries |
| 296 | + """(Deprecated) Folder - Download audit log entries |
294 | 297 |
|
295 | 298 | Returns all audit log entries of the folder for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
296 | 299 |
|
@@ -325,6 +328,7 @@ def list_folder_audit_log_entries_without_preload_content( |
325 | 328 | :type _host_index: int, optional |
326 | 329 | :return: Returns the result object. |
327 | 330 | """ # noqa: E501 |
| 331 | + warnings.warn("GET /v2/folders/{folderId} is deprecated.", DeprecationWarning) |
328 | 332 |
|
329 | 333 | _param = self._list_folder_audit_log_entries_serialize( |
330 | 334 | folder_id=folder_id, |
@@ -470,7 +474,7 @@ def list_organization_audit_log_entries( |
470 | 474 | _headers: Optional[Dict[StrictStr, Any]] = None, |
471 | 475 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
472 | 476 | ) -> ListAuditLogEntriesResponse: |
473 | | - """Organization - Download audit log entries |
| 477 | + """(Deprecated) Organization - Download audit log entries |
474 | 478 |
|
475 | 479 | Returns all audit log entries of the organization for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
476 | 480 |
|
@@ -505,6 +509,7 @@ def list_organization_audit_log_entries( |
505 | 509 | :type _host_index: int, optional |
506 | 510 | :return: Returns the result object. |
507 | 511 | """ # noqa: E501 |
| 512 | + warnings.warn("GET /v2/organizations/{organizationId} is deprecated.", DeprecationWarning) |
508 | 513 |
|
509 | 514 | _param = self._list_organization_audit_log_entries_serialize( |
510 | 515 | organization_id=organization_id, |
@@ -576,7 +581,7 @@ def list_organization_audit_log_entries_with_http_info( |
576 | 581 | _headers: Optional[Dict[StrictStr, Any]] = None, |
577 | 582 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
578 | 583 | ) -> ApiResponse[ListAuditLogEntriesResponse]: |
579 | | - """Organization - Download audit log entries |
| 584 | + """(Deprecated) Organization - Download audit log entries |
580 | 585 |
|
581 | 586 | Returns all audit log entries of the organization for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
582 | 587 |
|
@@ -611,6 +616,7 @@ def list_organization_audit_log_entries_with_http_info( |
611 | 616 | :type _host_index: int, optional |
612 | 617 | :return: Returns the result object. |
613 | 618 | """ # noqa: E501 |
| 619 | + warnings.warn("GET /v2/organizations/{organizationId} is deprecated.", DeprecationWarning) |
614 | 620 |
|
615 | 621 | _param = self._list_organization_audit_log_entries_serialize( |
616 | 622 | organization_id=organization_id, |
@@ -682,7 +688,7 @@ def list_organization_audit_log_entries_without_preload_content( |
682 | 688 | _headers: Optional[Dict[StrictStr, Any]] = None, |
683 | 689 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
684 | 690 | ) -> RESTResponseType: |
685 | | - """Organization - Download audit log entries |
| 691 | + """(Deprecated) Organization - Download audit log entries |
686 | 692 |
|
687 | 693 | Returns all audit log entries of the organization for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
688 | 694 |
|
@@ -717,6 +723,7 @@ def list_organization_audit_log_entries_without_preload_content( |
717 | 723 | :type _host_index: int, optional |
718 | 724 | :return: Returns the result object. |
719 | 725 | """ # noqa: E501 |
| 726 | + warnings.warn("GET /v2/organizations/{organizationId} is deprecated.", DeprecationWarning) |
720 | 727 |
|
721 | 728 | _param = self._list_organization_audit_log_entries_serialize( |
722 | 729 | organization_id=organization_id, |
@@ -860,7 +867,7 @@ def list_project_audit_log_entries( |
860 | 867 | _headers: Optional[Dict[StrictStr, Any]] = None, |
861 | 868 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
862 | 869 | ) -> ListAuditLogEntriesResponse: |
863 | | - """Project - Download audit log entries |
| 870 | + """(Deprecated) Project - Download audit log entries |
864 | 871 |
|
865 | 872 | Returns all audit log entries of the project for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
866 | 873 |
|
@@ -895,6 +902,7 @@ def list_project_audit_log_entries( |
895 | 902 | :type _host_index: int, optional |
896 | 903 | :return: Returns the result object. |
897 | 904 | """ # noqa: E501 |
| 905 | + warnings.warn("GET /v2/projects/{projectId} is deprecated.", DeprecationWarning) |
898 | 906 |
|
899 | 907 | _param = self._list_project_audit_log_entries_serialize( |
900 | 908 | project_id=project_id, |
@@ -964,7 +972,7 @@ def list_project_audit_log_entries_with_http_info( |
964 | 972 | _headers: Optional[Dict[StrictStr, Any]] = None, |
965 | 973 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
966 | 974 | ) -> ApiResponse[ListAuditLogEntriesResponse]: |
967 | | - """Project - Download audit log entries |
| 975 | + """(Deprecated) Project - Download audit log entries |
968 | 976 |
|
969 | 977 | Returns all audit log entries of the project for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
970 | 978 |
|
@@ -999,6 +1007,7 @@ def list_project_audit_log_entries_with_http_info( |
999 | 1007 | :type _host_index: int, optional |
1000 | 1008 | :return: Returns the result object. |
1001 | 1009 | """ # noqa: E501 |
| 1010 | + warnings.warn("GET /v2/projects/{projectId} is deprecated.", DeprecationWarning) |
1002 | 1011 |
|
1003 | 1012 | _param = self._list_project_audit_log_entries_serialize( |
1004 | 1013 | project_id=project_id, |
@@ -1068,7 +1077,7 @@ def list_project_audit_log_entries_without_preload_content( |
1068 | 1077 | _headers: Optional[Dict[StrictStr, Any]] = None, |
1069 | 1078 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
1070 | 1079 | ) -> RESTResponseType: |
1071 | | - """Project - Download audit log entries |
| 1080 | + """(Deprecated) Project - Download audit log entries |
1072 | 1081 |
|
1073 | 1082 | Returns all audit log entries of the project for the specified period. \\ Period must not be longer than 24 hours within the last 90 days. |
1074 | 1083 |
|
@@ -1103,6 +1112,7 @@ def list_project_audit_log_entries_without_preload_content( |
1103 | 1112 | :type _host_index: int, optional |
1104 | 1113 | :return: Returns the result object. |
1105 | 1114 | """ # noqa: E501 |
| 1115 | + warnings.warn("GET /v2/projects/{projectId} is deprecated.", DeprecationWarning) |
1106 | 1116 |
|
1107 | 1117 | _param = self._list_project_audit_log_entries_serialize( |
1108 | 1118 | project_id=project_id, |
|
0 commit comments