You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-1Lines changed: 54 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,13 @@ A Docker image can be built, then run by doing the following:
48
48
## API overview
49
49
> For full documentation of the API, you can find the swagger page hosted at the root url. See [Installing](#Installing) to run the application and browse the docs.
50
50
51
-
Currently the server just has one endpoint: `/bake`. This endpoint accepts a POST request with the following body:
51
+
The server has two endpoints: `/bake` and `/magic`.
52
+
53
+
### `/bake`
54
+
55
+
`/bake` allows a user to POST some input and configuration for a CyberChef Recipe. The application will run the input through the recipe and return the baked operation.
56
+
57
+
This endpoint accepts a POST request with the following body:
52
58
53
59
|Parameter|Type|Description|
54
60
|---|---|---|
@@ -160,6 +166,53 @@ Response:
160
166
}
161
167
```
162
168
169
+
### `/magic`
170
+
171
+
[Find more information about what the Magic operation does here](https://github.com/gchq/CyberChef/wiki/Automatic-detection-of-encoded-data-using-CyberChef-Magic)
172
+
173
+
The Magic operation cannot be used in conjunction with other applications in the `/bake` endpoint.
174
+
175
+
176
+
|Parameter|Type|Description|
177
+
|---|---|---|
178
+
input|String|The input data for the recipe. Currently accepts strings.
179
+
args|Object or Array|Arguments for the magic operation
CyberChef-server is released under the [Apache 2.0 Licence](https://www.apache.org/licenses/LICENSE-2.0) and is covered by [Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/copyright-and-re-use/crown-copyright/).
0 commit comments