kibana/docs/api/spaces-management/get_all.asciidoc
Chris Koehnke 12fcf015cb
[docs] Fix spaces api example json (#50411)
Make this example properly formatted json.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-02-07 07:19:32 -08:00

56 lines
1.1 KiB
Plaintext

[[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": ""
}
]
--------------------------------------------------