kibana/docs/api/spaces-management/get_all.asciidoc
Kaarina Tungseth fda3196611
[DOCS] Updates API requests and examples (#60695)
* [DOCS] Updates API requests and examples

* Review comments
2020-03-20 16:33:20 -05:00

53 lines
1.1 KiB
Text

[[spaces-api-get-all]]
=== Get all {kib} spaces API
++++
<titleabbrev>Get all spaces</titleabbrev>
++++
experimental[] Retrieve all {kib} spaces.
[[spaces-api-get-all-request]]
==== Request
`GET <kibana host>:<port>/api/spaces/space`
[[spaces-api-get-all-response-codes]]
==== Response code
`200`::
Indicates a successful call.
[[spaces-api-get-all-example]]
==== Example
The API returns the following:
[source,sh]
--------------------------------------------------
[
{
"id": "default",
"name": "Default",
"description" : "This is the Default Space",
"disabledFeatures": [],
"imageUrl": "",
"_reserved": true
},
{
"id": "marketing",
"name": "Marketing",
"description" : "This is the Marketing Space",
"color": "#aabbcc",
"disabledFeatures": ["apm"],
"initials": "MK",
"imageUrl": "data:image/png;base64,iVBORw0KGgoAAAANSU"
},
{
"id": "sales",
"name": "Sales",
"initials": "MK",
"disabledFeatures": ["discover", "timelion"],
"imageUrl": ""
}
]
--------------------------------------------------