From 1e34a84b3a94f027d69fb689de3a6cd8e0c3d652 Mon Sep 17 00:00:00 2001 From: AnneLaure1307 Date: Mon, 19 May 2025 11:23:31 +0200 Subject: [PATCH 1/3] Draft API v0 depreciation pages --- .../end-API-v0/API-v0-depreciation-notice.md | 32 +++++++++++++++++++ .../upgrade-from-API-v0-to-API-v1.md | 19 +++++++++++ 2 files changed, 51 insertions(+) create mode 100644 docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md create mode 100644 docs/thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md diff --git a/docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md b/docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md new file mode 100644 index 0000000000..ebf212a7a8 --- /dev/null +++ b/docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md @@ -0,0 +1,32 @@ +# API v0 deprecation notice + +This topic explains the deprecation of API v0 in TheHive and why you should upgrade to API v1. + +## Why API v0 is being deprecated + +API v0 is the original version of TheHive's API. It doesn't include many of the enhancements, performance improvements, and security features introduced in API v1. + +Deprecating API v0 simplifies the codebase and enables continued development of a faster, more secure, and more capable TheHive platform. + +## Who is affected + +You are affected by this deprecation if any of the following apply: + +* You call API endpoints that include `/v0/` or don't specify a version. +* You use the TH4PY Python client version 1.8, which relies on API v0. + +These calls may occur directly or through automation, such as analyzers, responders, scripts, or connectors. + +If you're unsure, run the following tests to check your setup: + +## Timeline + +* July 1, 2025: TH4PY v2.1, which uses API v1, becomes the officially supported version. +* TheHive 5.6 release: API v0 will be disabled by default. A configuration option will be available to temporarily re-enable it if needed. +* TheHive 5.7 release: API v0 will be deleted and will no longer be available. + +## What you should do + +See [Upgrade from API v0 to API v1](upgrade-from-API-v0-to-API-v1.md) for detailed instructions. + +

Next steps

\ No newline at end of file diff --git a/docs/thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md b/docs/thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md new file mode 100644 index 0000000000..5d2be846e7 --- /dev/null +++ b/docs/thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md @@ -0,0 +1,19 @@ +# How to Upgrade from API v0 to API v1 + +This topic provides step-by-step instructions for upgrading from API v0 to API v1, in response to the [API v0 deprecation](API-v0-depreciation-notice.md) in TheHive. + +!!! info "Are you concerned?" + + Use this procedure if you: + - Call API endpoints that include `/v0/` or don't specify a version + - Use the TH4PY Python client version 1.8, which relies on API v0 + + You might trigger these calls directly or through automation—such as analyzers, responders, scripts, or connectors. + + If you're unsure, see the [API v0 Deprecation Notice](API-v0-depreciation-notice.md) for tests you can run to verify your setup. + +## Update the API routes to use API v1 + +## Upgrade to TH4PY v2.1 + +

Next steps

\ No newline at end of file From aa9f8c07bcda8a4975e8e70ceeaa6642a2209169 Mon Sep 17 00:00:00 2001 From: AnneLaure1307 Date: Mon, 19 May 2025 11:37:34 +0200 Subject: [PATCH 2/3] Added pages in nav --- .../operations/end-API-v0/API-v0-depreciation-notice.md | 2 +- mkdocs.yml | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md b/docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md index ebf212a7a8..24d25fdbb9 100644 --- a/docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md +++ b/docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md @@ -1,4 +1,4 @@ -# API v0 deprecation notice +# API v0 Deprecation Notice This topic explains the deprecation of API v0 in TheHive and why you should upgrade to API v1. diff --git a/mkdocs.yml b/mkdocs.yml index 6c94d5c55d..eb8ff2a748 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -377,6 +377,9 @@ nav: - 'Index Management': thehive/operations/change-index.md - 'Troubleshooting Guide': thehive/operations/troubleshooting.md - 'Monitoring Setup': thehive/operations/monitoring.md + - 'API v0 Depreciation': + - 'API v0 Depreciation Notice': thehive/operations/end-API-v0/API-v0-depreciation-notice.md + - 'Upgrade from API v0 to API v1': thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md - 'Administration Guides': - 'TheHive - First Start': thehive/administration/first-start.md - 'Organizations': From fd6a2f29d7223da696d30da725397f09edbe45a3 Mon Sep 17 00:00:00 2001 From: AnneLaure1307 Date: Tue, 3 Jun 2025 17:03:58 +0200 Subject: [PATCH 3/3] Fixed typo --- ...v0-depreciation-notice.md => API-v0-deprecation-notice.md} | 0 .../operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md | 4 ++-- mkdocs.yml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) rename docs/thehive/operations/end-API-v0/{API-v0-depreciation-notice.md => API-v0-deprecation-notice.md} (100%) diff --git a/docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md b/docs/thehive/operations/end-API-v0/API-v0-deprecation-notice.md similarity index 100% rename from docs/thehive/operations/end-API-v0/API-v0-depreciation-notice.md rename to docs/thehive/operations/end-API-v0/API-v0-deprecation-notice.md diff --git a/docs/thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md b/docs/thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md index 5d2be846e7..35dae2451e 100644 --- a/docs/thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md +++ b/docs/thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md @@ -1,6 +1,6 @@ # How to Upgrade from API v0 to API v1 -This topic provides step-by-step instructions for upgrading from API v0 to API v1, in response to the [API v0 deprecation](API-v0-depreciation-notice.md) in TheHive. +This topic provides step-by-step instructions for upgrading from API v0 to API v1, in response to the [API v0 deprecation](API-v0-deprecation-notice.md) in TheHive. !!! info "Are you concerned?" @@ -10,7 +10,7 @@ This topic provides step-by-step instructions for upgrading from API v0 to API v You might trigger these calls directly or through automation—such as analyzers, responders, scripts, or connectors. - If you're unsure, see the [API v0 Deprecation Notice](API-v0-depreciation-notice.md) for tests you can run to verify your setup. + If you're unsure, see the [API v0 Deprecation Notice](API-v0-deprecation-notice.md) for tests you can run to verify your setup. ## Update the API routes to use API v1 diff --git a/mkdocs.yml b/mkdocs.yml index d66302d147..a52ea328db 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -402,8 +402,8 @@ nav: - 'Index Management': thehive/operations/change-index.md - 'Troubleshooting Guide': thehive/operations/troubleshooting.md - 'Monitoring Setup': thehive/operations/monitoring.md - - 'API v0 Depreciation': - - 'API v0 Depreciation Notice': thehive/operations/end-API-v0/API-v0-depreciation-notice.md + - 'API v0 Deprecation': + - 'API v0 Deprecation Notice': thehive/operations/end-API-v0/API-v0-deprecation-notice.md - 'Upgrade from API v0 to API v1': thehive/operations/end-API-v0/upgrade-from-API-v0-to-API-v1.md - 'Administration Guides': - 'TheHive - First Start': thehive/administration/first-start.md