Skip to content

DOC-158 #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
1e34a84
Draft API v0 depreciation pages
AnneLaure1307 May 19, 2025
64adcdd
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 19, 2025
aa9f8c0
Added pages in nav
AnneLaure1307 May 19, 2025
8ac9d6e
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 19, 2025
0a5ee46
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 19, 2025
1a6c542
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 19, 2025
caeec57
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 22, 2025
96eca62
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 26, 2025
1ba03cc
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 26, 2025
aa6b0d7
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 27, 2025
57e0d6d
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 27, 2025
2ad8cff
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 27, 2025
08a41c3
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 27, 2025
284840b
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 May 27, 2025
a15592c
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 Jun 2, 2025
45a61ad
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 Jun 3, 2025
fd6a2f2
Fixed typo
AnneLaure1307 Jun 3, 2025
a36f722
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 Jun 10, 2025
f7c7339
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 Jun 12, 2025
934a63c
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 Jun 20, 2025
c657b55
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 Jun 23, 2025
c0527ad
Merge remote-tracking branch 'origin/main' into DOC-158
AnneLaure1307 Jun 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/thehive/operations/end-API-v0/API-v0-deprecation-notice.md
Original file line number Diff line number Diff line change
@@ -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.

<h2>Next steps</h2>
Original file line number Diff line number Diff line change
@@ -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-deprecation-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-deprecation-notice.md) for tests you can run to verify your setup.

## Update the API routes to use API v1

## Upgrade to TH4PY v2.1

<h2>Next steps</h2>
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,9 @@ nav:
- 'Index Management': thehive/operations/change-index.md
- 'Troubleshooting Guide': thehive/operations/troubleshooting.md
- 'Monitoring Setup': thehive/operations/monitoring.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
- 'Organizations':
Expand Down