This repository was archived by the owner on Sep 20, 2023. It is now read-only.
Cortex job api documentation #11
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documentation for the Cortex job API
nadouani
reviewed
Sep 19, 2017
|
|
||
| Required attributes: | ||
| - `analyzerId` (string): identifier of the analyzer used by the job | ||
| - `status` (enumeration): status of the job (`InProgress`, `Success`, `Failure`) **default=`InProgress`** |
There was a problem hiding this comment.
This is an internal field managed by the backend. It's be better to list it under a Attributes generated by the backend section.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation was not explaining how we could interact with the API to trigger Cortex jobs. I wrote a few lines about Cortex jobs and how to create one (in fact, only the part that I tested) and I set a base structure for future documentation about connectors.
I hope this is to your liking.
This closes TheHive-Project/TheHive#308.