osd-config

Query OpenSearch Dashboards APIs to manage workspace configurations and saved objects.

34|32|Updated Jan 28, 2026
One-click install
npx skills add https://github.com/opensearch-project/observability-stack --skill osd-config
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: osd-config
Source: https://github.com/opensearch-project/observability-stack/tree/main/claude-code-observability-plugin/skills/osd-config
Command: npx skills add https://github.com/opensearch-project/observability-stack --skill osd-config

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enables programmatic discovery and management of OpenSearch Dashboards configurations via REST APIs, streamlining workspace setup, index pattern discovery, and saved-object configurations.

Core Features & Use Cases

  • Discover workspaces and retrieve workspace details using the OSD API.
  • List and inspect index patterns, saved objects, and APM correlation configurations across workspaces.
  • Use cases include automating configuration auditing, cross-workspace data governance, and rapid workspace onboarding.

Quick Start

Run a curl command against your OpenSearch Dashboards instance to list workspaces and verify access.

Frequently Asked Questions about osd-config

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate OpenSearch Dashboards workspace configuration via API?

You need a reachable OpenSearch Dashboards endpoint, valid credentials, and the osd-xsrf header for protected endpoints. Bash and curl are used as the primary tools to interact with the OSD APIs for configuration management.

How do I list saved objects and index patterns across multiple workspaces in OpenSearch Dashboards?

Querying the OSD API allows you to programmatically discover workspaces, inspect saved objects, and retrieve dataset mappings across your OpenSearch Dashboards environments.

What do I need to access protected OpenSearch Dashboards API endpoints?

You must supply the osd-xsrf header alongside valid credentials when making curl requests to protected OSD endpoints to successfully manage workspace configurations and saved objects.

Can I use Bash and curl to inspect APM correlation configurations in OpenSearch Dashboards?

The OSD API supports inspecting APM correlations directly through curl commands, allowing you to retrieve and manage these configurations alongside index patterns and workspace details.