Skip to content

Commit c2591c9

Browse files
committed
[ADD] Link to the new API doc
1 parent 3fb20f2 commit c2591c9

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/operations/api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ IRIS is meant to be plug-able and be integrated with the existing environments.
33

44
Through the REST API, one can do almost as much as it is possible to do through the web interface. Under the hood, the web interface is actually talking to the API.
55

6+
The API endpoints are reachable on the same port as the web interface, i.e 443/HTTPS by default.
67

78
!!! hint
89
A Python client is available [here](https://github.com/dfir-iris/iris-client) to ease the automation.
@@ -40,7 +41,7 @@ Use the references below to check which API version applies to your IRIS version
4041
| v2.0.x| [API v2.0.0](../_static/iris_api_reference_v2.0.0.html) |
4142
| v2.1.x| [API v2.0.1](../_static/iris_api_reference_v2.0.1.html) |
4243
| v2.2.x| [API v2.0.1](../_static/iris_api_reference_v2.0.1.html) |
43-
| v2.3.x| [API v2.0.1](../_static/iris_api_reference_v2.0.2.html) |
44+
| v2.3.x| [API v2.0.2](../_static/iris_api_reference_v2.0.2.html) |
4445

4546

4647

@@ -50,7 +51,7 @@ For example, to list all the cases:
5051

5152
```bash
5253
curl --request GET \
53-
--url http://localhost:8000/manage/cases/list?cid=1 \
54+
--url http://<yourserver_ip>/manage/cases/list?cid=1 \
5455
--header 'Authorization: Bearer mWpCUVNzBMU5EnbIAK50jLPhYjKBTHZjobdogc_n_yixpJTmt9tzAf8WYDI7m5XgB9wCJnlaXlHIh9RZjtp2fA' \
5556
--header 'Content-Type: application/json'
5657
```

0 commit comments

Comments
 (0)