OverviewHistoryStatsSecurity
npx skills add ...
Documentation
SKILL.md
npx skills add elastic/agent-skills --skill cloud-manage-project
Manages existing Elastic Cloud Serverless projects: list, get, update, delete, reset credentials, resume, and load saved credentials. Connects to existing projects by resolving endpoints and acquiring scoped Elasticsearch API keys. Use when performing day-2 operations on serverless projects, connecting to an existing project, loading or resetting project credentials, or looking up project details.
npx skills add elastic/agent-skills --skill cloud-manage-project
Perform day-2 operations on Elastic Cloud Serverless projects using the Serverless REST API.
EC_API_KEY is configured. If not, run cloud-setup skill first.403 Forbidden), stop and ask the user to
verify the provided API key permissions.cloud-setup is unavailable)If this skill is installed standalone and cloud-setup is not available, instruct the user to configure Cloud
environment variables manually before running commands. Never ask the user to paste API keys in chat.
| Variable | Required | Description |
|---|---|---|
EC_API_KEY | Yes | Elastic Cloud API key used for project management operations. |
EC_BASE_URL | No | Cloud API base URL (default: https://api.elastic-cloud.com). |
Note: If
EC_API_KEYis missing, or the user does not have a Cloud API key yet, direct the user to generate one at Elastic Cloud API keys, then configure it locally using the steps below.
Preferred method (agent-friendly): create a .env file in the project root:
All cloud/* scripts auto-load .env from the working directory.
Alternative: export directly in the terminal:
Terminal exports may not be visible to sandboxed agents running in separate shell sessions, so prefer .env when using
an agent.
.elastic-credentials file instead. The admin password must
never appear in chat history, thinking traces, or agent output — even when using it to create an API key, pass it
directly via shell variable substitution without echoing..elastic-credentials automatically. The password is redacted from stdout. Never read or display the contents of
.elastic-credentials in chat.admin password saved by create-project and
reset-credentials exists solely to bootstrap a scoped API key — never use it for direct Elasticsearch operations.
load-credentials excludes admin credentials by default; pass --include-admin only for key creation.ELASTICSEARCH_API_KEY is set. If
only admin credentials are available, create a scoped API key via elasticsearch-authn. If that skill is not
installed, ask the user to install it or create the key manually in Kibana > Stack Management > API keys.--type and --id (except list, which only needs
--type).EC_API_KEY) for project management operations
(list, get, update, delete). Elasticsearch operations require a separate Elasticsearch API key
(ELASTICSEARCH_API_KEY) that authenticates against the project's Elasticsearch endpoint. Do not confuse the two.Use this workflow when the user asks to query or manage a project the agent did not create in the current session. It resolves the project, saves its endpoints, and ensures working Elasticsearch credentials before proceeding.
This workflow only applies to Elastic Cloud Serverless projects. If the user's Elasticsearch instance is self-managed or Elastic Cloud Hosted, this skill does not apply — skip it and proceed with the relevant skill directly. If unsure, ask the user: "Is your Elasticsearch instance an Elastic Cloud Serverless project?"
Ask the user for the project name if not already provided. Infer the project type from the user's request:
| User says | --type |
|---|---|
| "search project", "elasticsearch project", vector search | elasticsearch |
| "observability project", "o11y", logs, metrics, traces, APM | observability |
| "security project", "SIEM", detections, endpoint protection | security |
If the type is ambiguous, list all three types to find the project.
Match the user's reference (name, partial name, or alias) against the list results. If multiple projects match or none match, present the candidates and ask the user to pick.
Once a single project is identified, check whether .elastic-credentials already has entries for this project (from a
previous session). If so, load them with load-credentials:
This sets all saved environment variables for the project — endpoints and any previously created Elasticsearch API keys
— in a single command. Admin credentials (ELASTICSEARCH_USERNAME/ELASTICSEARCH_PASSWORD) are intentionally excluded.
Later sections for the same project automatically overwrite earlier values, so the most recent credentials always win.
If load-credentials reports no matching entries, fetch the project details from the API and export endpoints manually:
Then export the endpoint URLs from the response. The available endpoints depend on the project type.
All project types:
Observability projects (additional):
Security projects (additional):
If load-credentials set ELASTICSEARCH_API_KEY, verify the credentials work:
Confirm the response contains a valid username and "authentication_type": "api_key" before proceeding. If
verification succeeds, skip the rest of this step.
If no credentials were loaded, or verification fails, ask the user: "Do you have an existing Elasticsearch API key for this project?"
If yes — have the user add it to .elastic-credentials (see "Credential file format"). Do not accept keys in chat.
Reload and verify:
If no — follow this recovery path:
Confirm with the user, then reset the admin bootstrap credentials:
The new password is saved to .elastic-credentials with the project name in the header. Direct the user to that file
— do not display its contents.
Load credentials with --include-admin so the admin password is available for API key creation:
Use the admin credentials to create a scoped Elasticsearch API key via elasticsearch-authn if available. If that
skill is not installed, ask the user to install it or create the key manually in Kibana > Stack Management > API
keys. Scope the key to only the privileges the user needs.
After creating the API key, save it to .elastic-credentials using the project-specific header format (see
"Credential file format" below). Then reload without --include-admin to drop admin credentials from the
environment and verify:
Confirm the response shows a valid username and "authentication_type": "api_key" before proceeding.
See references/credential-file-format.md for the full format specification.
Or by project ID:
Parses .elastic-credentials, merges all sections for the matching project, and prints export statements. Admin
credentials (ELASTICSEARCH_USERNAME/ELASTICSEARCH_PASSWORD) are excluded by default — only endpoints and API keys
are exported. Add --include-admin when you need admin credentials to create an API key.
Use --type observability or --type security to list other project types.
Only the fields provided are updated (PATCH semantics). Supported fields: --name, --alias, --tag,
--search-power, --boost-window, --max-retention-days, --default-retention-days.
The alias is an RFC-1035 domain label (lowercase alphanumeric and hyphens, max 50 chars) that becomes part of the project's endpoint URLs. Changing the alias changes all endpoint URLs, which breaks existing clients pointing to the old URLs. Warn the user about this before applying.
Tags are key-value metadata pairs for team tracking, cost attribution, and organization. Pass --tag KEY:VALUE for each
tag. Multiple tags can be set in a single update.
Tags are sent as metadata.tags in the API request. Setting tags replaces all existing tags on the project — include
any existing tags the user wants to keep.
For Elasticsearch projects, two fields control query performance and data caching in the Search AI Lake. Ingested data is stored in cost-efficient general storage. A cache layer on top provides faster search speed for recent and frequently queried data — this cached data is considered search-ready.
| Flag | Range | Description |
|---|---|---|
--search-power | 28–3000 | Query performance level. Higher values improve performance but increase cost |
--boost-window | 1–180 | Days of data eligible for boosted caching (default: 7) |
Search Power controls the speed of searches by provisioning more or fewer query resources. Common presets (matching the Cloud UI):
| Value | Preset | Behavior |
|---|---|---|
| 28 | On-demand | Autoscales with lower baseline. More variable latency, reduced max throughput |
| 100 | Performant | Consistently low latency, autoscales for moderately high throughput |
| 250 | High availability | Optimized for high-throughput scenarios, maintains low latency at high volumes |
When the user asks for a preset by name, map it to the corresponding value. Custom values within 28–3000 are also valid.
Warn the user about cost implications before updating search_power. Higher values increase VCU consumption and may
result in higher bills. Confirm the new value with the user before applying.
Non-time-series data is always search-ready. The boost window determines how much time-series data (documents with a
@timestamp field) is also kept in the fast cache layer. Increasing the window means a larger portion of time-series
data becomes search-ready, which improves query speed for recent data but increases the search-ready data volume.
For security projects, two fields control how long data is retained in the Search AI Lake. Retention is configured per data stream, but these project-level settings enforce global boundaries.
| Flag | Unit | Description |
|---|---|---|
--max-retention-days | days | Maximum retention period for any data stream in the project |
--default-retention-days | days | Default retention applied to data streams without a custom one |
Warn the user before reducing max-retention-days. Lowering the maximum permanently deletes data older than the new
limit. Confirm the new value with the user before applying.
Always confirm with the user before resetting.
The new password is saved to .elastic-credentials automatically. Tell the user to open that file — do not display its
contents in chat.
Always confirm with the user before deleting.
Projects can be automatically suspended after their trial period expires. Resume with:
After resuming, poll the project status until the phase changes from initializing to initialized.
cloud-setup skill first if EC_API_KEY is not set.cloud-create-project skill to create new projects — this skill handles existing projects only.search_power. Confirm the new value with the user first.max-retention-days. Data older than the new maximum is permanently deleted.get first and include any the user wants to
keep.| Command | Description |
|---|---|
list | List projects by type |
get | Get project details by ID |
update | Update project name, alias, tags, or search_lake settings |
reset-credentials | Reset project credentials (new password) |
delete | Delete a project |
resume | Resume a suspended project |
load-credentials | Load a project's saved credentials from .elastic-credentials |
| Flag | Commands | Description |
|---|---|---|
--type | list, get, update, reset-credentials, delete, resume | Project type: elasticsearch, observability, security |
--id | get, update, reset-credentials, delete, resume, load-credentials | Project ID |
--name | update, load-credentials | Project name (update: new name; load-credentials: lookup) |
--alias | update | New project alias |
--tag | update | Tag as KEY:VALUE (repeatable, replaces all tags) |
--search-power | update | Search power 28–3000 (elasticsearch only) |
--boost-window | update | Boost window 1–180 days (elasticsearch only) |
--max-retention-days | update | Max data retention in days (security only) |
--default-retention-days | update | Default data retention in days (security only) |
--include-admin | load-credentials | Include admin username/password (API key bootstrapping only) |
--wait-seconds | reset-credentials | Seconds to wait for credential propagation (0 to skip) |
| Variable | Required | Description |
|---|---|---|
EC_API_KEY | Yes | Elastic Cloud API key (project management operations) |
EC_BASE_URL | No | Cloud API base URL (default: https://api.elastic-cloud.com) |
ELASTICSEARCH_URL | Output | Elasticsearch URL (set after resolving a project for downstream skills) |
KIBANA_URL | Output | Kibana URL (set after resolving a project for downstream skills) |
APM_URL | Output | APM endpoint (observability projects only) |
INGEST_URL | Output | OTLP ingest endpoint (observability and security projects) |
ELASTICSEARCH_API_KEY | Output | Elasticsearch API key (for stack-level operations) |
Connect to Existing Project:
- [ ] Step 1: Resolve the project
- [ ] Step 2: Get project details and load credentials
- [ ] Step 3: Acquire Elasticsearch credentialspython3 skills/cloud/manage-project/scripts/manage-project.py list \
--type elasticsearchpython3 skills/cloud/manage-project/scripts/manage-project.py list \
--type elasticsearcheval $(python3 skills/cloud/manage-project/scripts/manage-project.py load-credentials \
--name "<project-name>")eval $(python3 skills/cloud/manage-project/scripts/manage-project.py load-credentials \
--name "<project-name>")python3 skills/cloud/manage-project/scripts/manage-project.py get \
--type elasticsearch \
--id <project-id>python3 skills/cloud/manage-project/scripts/manage-project.py get \
--type elasticsearch \
--id <project-id>export ELASTICSEARCH_URL="<elasticsearch_endpoint>"
export KIBANA_URL="<kibana_endpoint>"export APM_URL="<apm_endpoint>"
export INGEST_URL="<ingest_endpoint>"export INGEST_URL="<ingest_endpoint>"curl -H "Authorization: ApiKey ${ELASTICSEARCH_API_KEY}" \
"${ELASTICSEARCH_URL}/_security/_authenticate"eval $(python3 skills/cloud/manage-project/scripts/manage-project.py load-credentials \
--name "<project-name>")
curl -H "Authorization: ApiKey ${ELASTICSEARCH_API_KEY}" \
"${ELASTICSEARCH_URL}/_security/_authenticate"eval $(python3 skills/cloud/manage-project/scripts/manage-project.py load-credentials \
--name "<project-name>")
curl -H "Authorization: ApiKey ${ELASTICSEARCH_API_KEY}" \
"${ELASTICSEARCH_URL}/_security/_authenticate"