Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Kibana Saved Objects Allowed Types #126860

Closed
stefnestor opened this issue Mar 3, 2022 · 3 comments
Closed

[Doc] Kibana Saved Objects Allowed Types #126860

stefnestor opened this issue Mar 3, 2022 · 3 comments

Comments

@stefnestor
Copy link
Contributor

👋🏼 elastic/support-diagnostics#479 (comment) documents an API endpoint I've validated on 7.17.0 which AFAICT doesn't exist in docs. Is this endpoint considered internal or may we add it to Kibana Docs? I find it useful to know eligible Saved Object types.

GET /api/kibana/management/saved_objects/_allowed_types

Example response

{"types":[{"name":"config","namespaceType":"single","hidden":false,"displayName":"config"},{"name":"url","namespaceType":"single","hidden":false,"displayName":"url"},{"name":"index-pattern","namespaceType":"single","hidden":false,"displayName":"index-pattern"},{"name":"query","namespaceType":"single","hidden":false,"displayName":"query"},{"name":"tag","namespaceType":"single","hidden":false,"displayName":"tag"},{"name":"canvas-element","namespaceType":"single","hidden":false,"displayName":"canvas-element"},{"name":"canvas-workpad","namespaceType":"single","hidden":false,"displayName":"canvas-workpad"},{"name":"action","namespaceType":"single","hidden":true,"displayName":"connector"},{"name":"alert","namespaceType":"single","hidden":true,"displayName":"rule"},{"name":"visualization","namespaceType":"single","hidden":false,"displayName":"visualization"},{"name":"graph-workspace","namespaceType":"single","hidden":false,"displayName":"graph-workspace"},{"name":"dashboard","namespaceType":"single","hidden":false,"displayName":"dashboard"},{"name":"map","namespaceType":"single","hidden":false,"displayName":"map"},{"name":"lens","namespaceType":"single","hidden":false,"displayName":"lens"},{"name":"cases","namespaceType":"single","hidden":true,"displayName":"cases"},{"name":"search","namespaceType":"single","hidden":false,"displayName":"search"},{"name":"osquery-saved-query","namespaceType":"multiple-isolated","hidden":false,"displayName":"osquery-saved-query"},{"name":"osquery-pack","namespaceType":"multiple-isolated","hidden":false,"displayName":"osquery-pack"},{"name":"uptime-dynamic-settings","namespaceType":"single","hidden":false,"displayName":"uptime-dynamic-settings"},{"name":"infrastructure-ui-source","namespaceType":"single","hidden":false,"displayName":"infrastructure-ui-source"},{"name":"metrics-explorer-view","namespaceType":"single","hidden":false,"displayName":"metrics-explorer-view"},{"name":"inventory-view","namespaceType":"single","hidden":false,"displayName":"inventory-view"},{"name":"apm-indices","namespaceType":"agnostic","hidden":false,"displayName":"apm-indices"}]}

Appears added in v7.8.0 via #61700 by @pgayvallet

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@pgayvallet
Copy link
Contributor

/api/kibana/management/saved_objects/_allowed_types was meant to be internal. To even go further, all /api/kibana/management/saved_objects/* routes are supposed to be only internally used by the SavedObjectManagement plugin, but these routes existed before we even came to the /api vs /internal distinction, so when we migrated the plugin during the KibanaPlatform migration, we kept the /api prefix.

@stefnestor
Copy link
Contributor Author

Ah, gotcha 😂. Well it's a lovely find for me. Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants