@@ -24,38 +24,42 @@ Running server:
24
24
25
25
## HTTP API
26
26
27
- ### Check if index exists
27
+ ### Index management
28
+
29
+ #### Check if index exists
28
30
29
31
Returns HTTP status 200 if the index exists.
30
32
31
33
```
32
34
HEAD /:indexname
33
35
```
34
36
35
- ### Get index info
37
+ #### Get index info
36
38
37
39
Returns information about an index.
38
40
39
41
```
40
42
GET /:indexname
41
43
```
42
- ### Create index
44
+ #### Create index
43
45
44
46
Creates a new index.
45
47
46
48
```
47
49
PUT /:indexname
48
50
```
49
51
50
- ### Delete index
52
+ #### Delete index
51
53
52
54
Deletes an index.
53
55
54
56
```
55
57
DELETE /:indexname
56
58
```
57
59
58
- ### Update
60
+ ### Fingerprint management
61
+
62
+ #### Update
59
63
60
64
Performs multiple operations on an index.
61
65
@@ -72,7 +76,7 @@ POST /:indexname/_update
72
76
}
73
77
```
74
78
75
- ### Search
79
+ #### Search
76
80
77
81
Searches for a fingerprint in the index.
78
82
@@ -84,15 +88,15 @@ POST /:indexname/_search
84
88
{"query" : [100 , 200 , 300 ], "timeout" : 10 }
85
89
```
86
90
87
- ### Check if fingerprint exists
91
+ #### Check if fingerprint exists
88
92
89
93
Returns HTTP status 200 if the fingerprint exists.
90
94
91
95
```
92
96
HEAD /:indexname/:fpid
93
97
```
94
98
95
- ### Get fingerprint info
99
+ #### Get fingerprint info
96
100
97
101
Gets information about a fingeprint.
98
102
@@ -102,7 +106,7 @@ There is no way to get back the original hashes, they are not stored in a way th
102
106
GET /:indexname/:fpid
103
107
```
104
108
105
- ### Update fingerprint
109
+ #### Update single fingerprint
106
110
107
111
Updates a single fingerprint.
108
112
@@ -116,7 +120,7 @@ PUT /:indexname/:fpid
116
120
{"hashes" : [100 , 200 , 300 ]}
117
121
```
118
122
119
- ### Delete fingerprint
123
+ #### Delete single fingerprint
120
124
121
125
Deletes a single fingerprint.
122
126
@@ -126,3 +130,17 @@ Prefer using `/_update` for bulk operations.
126
130
DELETE /:indexname/:fpid
127
131
```
128
132
133
+ ### System utilities
134
+
135
+ #### Healhcheck
136
+
137
+ ```
138
+ GET /_health
139
+ GET /:indexname/_health
140
+ ```
141
+
142
+ #### Prometheus metrics
143
+
144
+ ```
145
+ GET /_metrics
146
+ ```
0 commit comments