1e3f14395c
* [DOCS] API intro * Logstash configuration management * Reformatting * Comments from Josh * Commets from Gail * Fixed broken things
55 lines
1.1 KiB
Text
55 lines
1.1 KiB
Text
[[spaces-api-get-all]]
|
|
=== Get all {kib} spaces API
|
|
++++
|
|
<titleabbrev>Get all spaces</titleabbrev>
|
|
++++
|
|
|
|
Retrieve all {kib} spaces.
|
|
|
|
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
|
|
|
|
[[spaces-api-get-all-request]]
|
|
==== Request
|
|
|
|
`GET /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,js]
|
|
--------------------------------------------------
|
|
[
|
|
{
|
|
"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": ""
|
|
},
|
|
]
|
|
--------------------------------------------------
|