Skip to content

Commit f58f5e6

Browse files
Resolve "Update api spec SOARCA core"
1 parent aa09314 commit f58f5e6

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

doc/soarca-api.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ We will use HTTP status codes https://en.wikipedia.org/wiki/List_of_HTTP_status_
1414
@startuml
1515
protocol UiEndpoint {
1616
GET /workflow
17+
GET /workflow/meta
1718
POST /workflow
1819
GET /workflow/workflow-id
1920
PUT /workflow/workflow-id
@@ -154,15 +155,43 @@ None
154155

155156
```plantuml
156157
@startjson
157-
{
158-
"workflows": [
159-
{
160-
"workflow-id": "xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx",
161-
"workflow-name": "name",
162-
"workflow-description": "description"
163-
}
164-
]
165-
}
158+
159+
[
160+
{
161+
"workflow": "<cacao-playbook> (json)"
162+
}
163+
]
164+
@endjson
165+
```
166+
167+
##### Error
168+
400/BAD REQUEST with payload:
169+
General error
170+
171+
#### GET `/workflow/meta`
172+
Get all workflow id's that are currently stored in SOAR-CA.
173+
174+
##### Call payload
175+
None
176+
177+
##### Response
178+
200/OK with payload:
179+
180+
```plantuml
181+
@startjson
182+
183+
[
184+
{
185+
"id": "<workflow id>",
186+
"name": "<workflow name>",
187+
"description": "<workflow id>",
188+
"created": "<creation data time>",
189+
"valid_from": "<valid from date time>",
190+
"valid_until": "<valid until date time>",
191+
"labels": ["label 1","label 2"]
192+
}
193+
]
194+
166195
@endjson
167196
```
168197

@@ -193,7 +222,7 @@ Create a new workflow that and store it in SOAR-CA. The format is
193222
```plantuml
194223
@startjson
195224
{
196-
"workflow-id": "xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx"
225+
"workflow": "<cacao-playbook> (json)"
197226
}
198227
@endjson
199228
```

0 commit comments

Comments
 (0)