@elastic/schemas 0.6.1 → 0.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/es/json/esql.delete_data_source.request.json +1 -0
- package/lib/cjs/es/json/esql.delete_dataset.request.json +1 -0
- package/lib/cjs/es/json/esql.get_data_source.request.json +1 -0
- package/lib/cjs/es/json/esql.get_dataset.request.json +1 -0
- package/lib/cjs/es/json/esql.put_data_source.request.json +1 -0
- package/lib/cjs/es/json/esql.put_dataset.request.json +1 -0
- package/lib/cjs/es/tools/apis/esql.delete_data_source.d.ts +3 -0
- package/lib/cjs/es/tools/apis/esql.delete_data_source.d.ts.map +1 -0
- package/lib/cjs/es/tools/apis/esql.delete_data_source.js +24 -0
- package/lib/cjs/es/tools/apis/esql.delete_data_source.js.map +1 -0
- package/lib/cjs/es/tools/apis/esql.delete_dataset.d.ts +3 -0
- package/lib/cjs/es/tools/apis/esql.delete_dataset.d.ts.map +1 -0
- package/lib/cjs/es/tools/apis/esql.delete_dataset.js +24 -0
- package/lib/cjs/es/tools/apis/esql.delete_dataset.js.map +1 -0
- package/lib/cjs/es/tools/apis/esql.get_data_source.d.ts +3 -0
- package/lib/cjs/es/tools/apis/esql.get_data_source.d.ts.map +1 -0
- package/lib/cjs/es/tools/apis/esql.get_data_source.js +24 -0
- package/lib/cjs/es/tools/apis/esql.get_data_source.js.map +1 -0
- package/lib/cjs/es/tools/apis/esql.get_dataset.d.ts +3 -0
- package/lib/cjs/es/tools/apis/esql.get_dataset.d.ts.map +1 -0
- package/lib/cjs/es/tools/apis/esql.get_dataset.js +24 -0
- package/lib/cjs/es/tools/apis/esql.get_dataset.js.map +1 -0
- package/lib/cjs/es/tools/apis/esql.put_data_source.d.ts +3 -0
- package/lib/cjs/es/tools/apis/esql.put_data_source.d.ts.map +1 -0
- package/lib/cjs/es/tools/apis/esql.put_data_source.js +24 -0
- package/lib/cjs/es/tools/apis/esql.put_data_source.js.map +1 -0
- package/lib/cjs/es/tools/apis/esql.put_dataset.d.ts +3 -0
- package/lib/cjs/es/tools/apis/esql.put_dataset.d.ts.map +1 -0
- package/lib/cjs/es/tools/apis/esql.put_dataset.js +24 -0
- package/lib/cjs/es/tools/apis/esql.put_dataset.js.map +1 -0
- package/lib/cjs/es/tools/index.d.ts.map +1 -1
- package/lib/cjs/es/tools/index.js +24 -0
- package/lib/cjs/es/tools/index.js.map +1 -1
- package/lib/cjs/es/tools/manifest.d.ts.map +1 -1
- package/lib/cjs/es/tools/manifest.js +6 -0
- package/lib/cjs/es/tools/manifest.js.map +1 -1
- package/lib/cjs/kibana/json/streams.delete-streams-name-queries-queryid.request.json +1 -1
- package/lib/cjs/kibana/json/streams.delete-streams-name.request.json +1 -1
- package/lib/cjs/kibana/json/streams.delete-streams-streamname-attachments-attachmenttype-attachmentid.request.json +1 -1
- package/lib/cjs/kibana/json/streams.get-streams-name-ingest.request.json +1 -1
- package/lib/cjs/kibana/json/streams.get-streams-name-queries.request.json +1 -1
- package/lib/cjs/kibana/json/streams.get-streams-name-query.request.json +1 -1
- package/lib/cjs/kibana/json/streams.get-streams-name-significant-events.request.json +1 -1
- package/lib/cjs/kibana/json/streams.get-streams-name.request.json +1 -1
- package/lib/cjs/kibana/json/streams.get-streams-streamname-attachments.request.json +1 -1
- package/lib/cjs/kibana/json/streams.put-streams-streamname-attachments-attachmenttype-attachmentid.request.json +1 -1
- package/lib/cjs/serverless/json/create_elasticsearch_project.request.json +1 -1
- package/lib/cjs/serverless/json/create_observability_project.request.json +1 -1
- package/lib/cjs/serverless/json/create_security_project.request.json +1 -1
- package/lib/cjs/serverless/json/get_elasticsearch_project_link_candidates.request.json +1 -1
- package/lib/cjs/serverless/json/get_observability_project_link_candidates.request.json +1 -1
- package/lib/cjs/serverless/json/get_security_project_link_candidates.request.json +1 -1
- package/lib/cjs/serverless/json/get_traffic_filter_metadata.request.json +1 -1
- package/lib/cjs/serverless/json/list_elasticsearch_projects.request.json +1 -1
- package/lib/cjs/serverless/json/list_observability_projects.request.json +1 -1
- package/lib/cjs/serverless/json/list_security_projects.request.json +1 -1
- package/lib/cjs/serverless/json/list_traffic_filters.request.json +1 -1
- package/lib/cjs/serverless/json/patch_elasticsearch_project.request.json +1 -1
- package/lib/cjs/serverless/json/patch_observability_project.request.json +1 -1
- package/lib/cjs/serverless/json/patch_security_project.request.json +1 -1
- package/lib/es/json/esql.delete_data_source.request.json +1 -0
- package/lib/es/json/esql.delete_dataset.request.json +1 -0
- package/lib/es/json/esql.get_data_source.request.json +1 -0
- package/lib/es/json/esql.get_dataset.request.json +1 -0
- package/lib/es/json/esql.put_data_source.request.json +1 -0
- package/lib/es/json/esql.put_dataset.request.json +1 -0
- package/lib/es/tools/apis/esql.delete_data_source.d.ts +3 -0
- package/lib/es/tools/apis/esql.delete_data_source.d.ts.map +1 -0
- package/lib/es/tools/apis/esql.delete_data_source.js +18 -0
- package/lib/es/tools/apis/esql.delete_data_source.js.map +1 -0
- package/lib/es/tools/apis/esql.delete_dataset.d.ts +3 -0
- package/lib/es/tools/apis/esql.delete_dataset.d.ts.map +1 -0
- package/lib/es/tools/apis/esql.delete_dataset.js +18 -0
- package/lib/es/tools/apis/esql.delete_dataset.js.map +1 -0
- package/lib/es/tools/apis/esql.get_data_source.d.ts +3 -0
- package/lib/es/tools/apis/esql.get_data_source.d.ts.map +1 -0
- package/lib/es/tools/apis/esql.get_data_source.js +18 -0
- package/lib/es/tools/apis/esql.get_data_source.js.map +1 -0
- package/lib/es/tools/apis/esql.get_dataset.d.ts +3 -0
- package/lib/es/tools/apis/esql.get_dataset.d.ts.map +1 -0
- package/lib/es/tools/apis/esql.get_dataset.js +18 -0
- package/lib/es/tools/apis/esql.get_dataset.js.map +1 -0
- package/lib/es/tools/apis/esql.put_data_source.d.ts +3 -0
- package/lib/es/tools/apis/esql.put_data_source.d.ts.map +1 -0
- package/lib/es/tools/apis/esql.put_data_source.js +18 -0
- package/lib/es/tools/apis/esql.put_data_source.js.map +1 -0
- package/lib/es/tools/apis/esql.put_dataset.d.ts +3 -0
- package/lib/es/tools/apis/esql.put_dataset.d.ts.map +1 -0
- package/lib/es/tools/apis/esql.put_dataset.js +18 -0
- package/lib/es/tools/apis/esql.put_dataset.js.map +1 -0
- package/lib/es/tools/index.d.ts.map +1 -1
- package/lib/es/tools/index.js +24 -0
- package/lib/es/tools/index.js.map +1 -1
- package/lib/es/tools/manifest.d.ts.map +1 -1
- package/lib/es/tools/manifest.js +6 -0
- package/lib/es/tools/manifest.js.map +1 -1
- package/lib/kibana/json/streams.delete-streams-name-queries-queryid.request.json +1 -1
- package/lib/kibana/json/streams.delete-streams-name.request.json +1 -1
- package/lib/kibana/json/streams.delete-streams-streamname-attachments-attachmenttype-attachmentid.request.json +1 -1
- package/lib/kibana/json/streams.get-streams-name-ingest.request.json +1 -1
- package/lib/kibana/json/streams.get-streams-name-queries.request.json +1 -1
- package/lib/kibana/json/streams.get-streams-name-query.request.json +1 -1
- package/lib/kibana/json/streams.get-streams-name-significant-events.request.json +1 -1
- package/lib/kibana/json/streams.get-streams-name.request.json +1 -1
- package/lib/kibana/json/streams.get-streams-streamname-attachments.request.json +1 -1
- package/lib/kibana/json/streams.put-streams-streamname-attachments-attachmenttype-attachmentid.request.json +1 -1
- package/lib/serverless/json/create_elasticsearch_project.request.json +1 -1
- package/lib/serverless/json/create_observability_project.request.json +1 -1
- package/lib/serverless/json/create_security_project.request.json +1 -1
- package/lib/serverless/json/get_elasticsearch_project_link_candidates.request.json +1 -1
- package/lib/serverless/json/get_observability_project_link_candidates.request.json +1 -1
- package/lib/serverless/json/get_security_project_link_candidates.request.json +1 -1
- package/lib/serverless/json/get_traffic_filter_metadata.request.json +1 -1
- package/lib/serverless/json/list_elasticsearch_projects.request.json +1 -1
- package/lib/serverless/json/list_observability_projects.request.json +1 -1
- package/lib/serverless/json/list_security_projects.request.json +1 -1
- package/lib/serverless/json/list_traffic_filters.request.json +1 -1
- package/lib/serverless/json/patch_elasticsearch_project.request.json +1 -1
- package/lib/serverless/json/patch_observability_project.request.json +1 -1
- package/lib/serverless/json/patch_security_project.request.json +1 -1
- package/package.json +1 -1
- package/src/es/json/esql._types.json +1 -1
- package/src/es/json/esql.delete_data_source.request.json +1 -0
- package/src/es/json/esql.delete_data_source.response.json +1 -0
- package/src/es/json/esql.delete_dataset.request.json +1 -0
- package/src/es/json/esql.delete_dataset.response.json +1 -0
- package/src/es/json/esql.get_data_source.request.json +1 -0
- package/src/es/json/esql.get_data_source.response.json +1 -0
- package/src/es/json/esql.get_dataset.request.json +1 -0
- package/src/es/json/esql.get_dataset.response.json +1 -0
- package/src/es/json/esql.put_data_source.request.json +1 -0
- package/src/es/json/esql.put_data_source.response.json +1 -0
- package/src/es/json/esql.put_dataset.request.json +1 -0
- package/src/es/json/esql.put_dataset.response.json +1 -0
- package/src/kibana/json/streams.delete-streams-name-queries-queryid.request.json +1 -1
- package/src/kibana/json/streams.delete-streams-name.request.json +1 -1
- package/src/kibana/json/streams.delete-streams-streamname-attachments-attachmenttype-attachmentid.request.json +1 -1
- package/src/kibana/json/streams.get-streams-name-ingest.request.json +1 -1
- package/src/kibana/json/streams.get-streams-name-queries.request.json +1 -1
- package/src/kibana/json/streams.get-streams-name-query.request.json +1 -1
- package/src/kibana/json/streams.get-streams-name-significant-events.request.json +1 -1
- package/src/kibana/json/streams.get-streams-name.request.json +1 -1
- package/src/kibana/json/streams.get-streams-streamname-attachments.request.json +1 -1
- package/src/kibana/json/streams.get-streams.request.json +1 -1
- package/src/kibana/json/streams.post-streams-disable.request.json +1 -1
- package/src/kibana/json/streams.post-streams-enable.request.json +1 -1
- package/src/kibana/json/streams.post-streams-resync.request.json +1 -1
- package/src/kibana/json/streams.put-streams-streamname-attachments-attachmenttype-attachmentid.request.json +1 -1
- package/src/serverless/json/create_elasticsearch_project.request.json +1 -1
- package/src/serverless/json/create_observability_project.request.json +1 -1
- package/src/serverless/json/create_security_project.request.json +1 -1
- package/src/serverless/json/get_elasticsearch_project.response.json +1 -1
- package/src/serverless/json/get_elasticsearch_project_link_candidates.request.json +1 -1
- package/src/serverless/json/get_elasticsearch_project_link_candidates.response.json +1 -1
- package/src/serverless/json/get_observability_project.response.json +1 -1
- package/src/serverless/json/get_observability_project_link_candidates.request.json +1 -1
- package/src/serverless/json/get_observability_project_link_candidates.response.json +1 -1
- package/src/serverless/json/get_security_project.response.json +1 -1
- package/src/serverless/json/get_security_project_link_candidates.request.json +1 -1
- package/src/serverless/json/get_security_project_link_candidates.response.json +1 -1
- package/src/serverless/json/get_traffic_filter_metadata.request.json +1 -1
- package/src/serverless/json/list_elasticsearch_projects.request.json +1 -1
- package/src/serverless/json/list_elasticsearch_projects.response.json +1 -1
- package/src/serverless/json/list_observability_projects.request.json +1 -1
- package/src/serverless/json/list_observability_projects.response.json +1 -1
- package/src/serverless/json/list_security_projects.request.json +1 -1
- package/src/serverless/json/list_security_projects.response.json +1 -1
- package/src/serverless/json/list_traffic_filters.request.json +1 -1
- package/src/serverless/json/patch_elasticsearch_project.request.json +1 -1
- package/src/serverless/json/patch_elasticsearch_project.response.json +1 -1
- package/src/serverless/json/patch_observability_project.request.json +1 -1
- package/src/serverless/json/patch_observability_project.response.json +1 -1
- package/src/serverless/json/patch_security_project.request.json +1 -1
- package/src/serverless/json/patch_security_project.response.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "patchObservabilityProject", "x-api": { "id": "observability-projects.patch-observability-project", "name": "patch-observability-project", "namespace": "observability-projects" }, "x-method": "PATCH", "x-path": "/api/v1/serverless/projects/observability/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the project", "x-found-in": "path" }, "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "traffic_filters": { "oneOf": [{ "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] } }, { "type": "null" }], "x-found-in": "body" }, "linked": { "oneOf": [{ "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, { "type": "null" }] } } }, "additionalProperties": false }, { "type": "null" }], "x-found-in": "body" }, "product_tier": { "enum": ["complete", "logs_essentials"], "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "null" }] } } }, "required": ["tags"], "x-found-in": "body" } }, "required": ["id"] }
|
|
1
|
+
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "patchObservabilityProject", "x-api": { "id": "observability-projects.patch-observability-project", "name": "patch-observability-project", "namespace": "observability-projects" }, "x-method": "PATCH", "x-path": "/api/v1/serverless/projects/observability/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the project", "x-found-in": "path" }, "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "traffic_filters": { "oneOf": [{ "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] } }, { "type": "null" }], "x-found-in": "body" }, "linked": { "oneOf": [{ "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, { "type": "null" }] }, "minProperties": 1 } }, "additionalProperties": false }, { "type": "null" }], "x-found-in": "body" }, "product_tier": { "enum": ["complete", "logs_essentials"], "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "null" }] }, "minProperties": 1 } }, "required": ["tags"], "x-found-in": "body" } }, "required": ["id"] }
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "patchSecurityProject", "x-api": { "id": "security-projects.patch-security-project", "name": "patch-security-project", "namespace": "security-projects" }, "x-method": "PATCH", "x-path": "/api/v1/serverless/projects/security/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the project", "x-found-in": "path" }, "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "admin_features_package": { "oneOf": [{ "enum": ["standard", "enterprise"] }, { "type": "null" }], "x-found-in": "body" }, "product_types": { "oneOf": [{ "type": "array", "items": { "type": "object", "properties": { "product_line": { "enum": ["security", "cloud", "endpoint"] }, "product_tier": { "enum": ["complete", "essentials"] } }, "required": ["product_line", "product_tier"] } }, { "type": "null" }], "x-found-in": "body" }, "search_lake": { "oneOf": [{ "type": "object", "properties": { "data_retention": { "oneOf": [{ "type": "object", "properties": { "max_retention_days": { "oneOf": [{ "type": "number" }, { "type": "null" }] }, "default_retention_days": { "oneOf": [{ "type": "number" }, { "type": "null" }] } } }, { "type": "null" }] } } }, { "type": "null" }], "x-found-in": "body" }, "traffic_filters": { "oneOf": [{ "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] } }, { "type": "null" }], "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "null" }] } } }, "required": ["tags"], "x-found-in": "body" }, "linked": { "oneOf": [{ "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, { "type": "null" }] } } }, "additionalProperties": false }, { "type": "null" }], "x-found-in": "body" } }, "required": ["id"] }
|
|
1
|
+
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "patchSecurityProject", "x-api": { "id": "security-projects.patch-security-project", "name": "patch-security-project", "namespace": "security-projects" }, "x-method": "PATCH", "x-path": "/api/v1/serverless/projects/security/{id}", "x-destructive": true, "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the project", "x-found-in": "path" }, "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "admin_features_package": { "oneOf": [{ "enum": ["standard", "enterprise"] }, { "type": "null" }], "x-found-in": "body" }, "product_types": { "oneOf": [{ "type": "array", "items": { "type": "object", "properties": { "product_line": { "enum": ["security", "cloud", "endpoint"] }, "product_tier": { "enum": ["complete", "essentials"] } }, "required": ["product_line", "product_tier"] } }, { "type": "null" }], "x-found-in": "body" }, "search_lake": { "oneOf": [{ "type": "object", "properties": { "data_retention": { "oneOf": [{ "type": "object", "properties": { "max_retention_days": { "oneOf": [{ "type": "number" }, { "type": "null" }] }, "default_retention_days": { "oneOf": [{ "type": "number" }, { "type": "null" }] } } }, { "type": "null" }] } } }, { "type": "null" }], "x-found-in": "body" }, "traffic_filters": { "oneOf": [{ "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] } }, { "type": "null" }], "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "null" }] }, "minProperties": 1 } }, "required": ["tags"], "x-found-in": "body" }, "linked": { "oneOf": [{ "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, { "type": "null" }] }, "minProperties": 1 } }, "additionalProperties": false }, { "type": "null" }], "x-found-in": "body" } }, "required": ["id"] }
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"esql._types__EsqlFormat":{"enum":["csv","json","tsv","txt","yaml","cbor","smile","arrow"]},"esql._types__ESQLParams":{"anyOf":[{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__SingleOrMultiValue"}},{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__NamedValue"}}]},"esql._types__SingleOrMultiValue":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__FieldValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}]},"esql._types__NamedValue":{"type":"object","additionalProperties":{"$ref":"./esql._types.json#/$defs/esql._types__NamedParameterValue"},"minProperties":1,"maxProperties":1},"esql._types__NamedParameterValue":{"anyOf":[{"$ref":"./esql._types.json#/$defs/esql._types__SingleOrMultiValue"},{"$ref":"./esql._types.json#/$defs/esql._types__ClassifiedNamedParameter"}],"description":"The value of a named ES|QL query parameter.\nIt is either a literal single or multi value, or a single-key object that classifies how\nthe parameter is interpreted."},"esql._types__ClassifiedNamedParameter":{"type":"object","properties":{"value":{"$ref":"./esql._types.json#/$defs/esql._types__SingleOrMultiValue","description":"Interpret the parameter as a literal value."},"identifier":{"type":"string","description":"Interpret the parameter as an identifier, such as a field or function name."},"pattern":{"type":"string","description":"Interpret the parameter as a pattern, such as an index or field name pattern."}},"description":"A named ES|QL query parameter supplied in its classified form.\nExactly one of `value`, `identifier`, or `pattern` must be set."},"esql._types__TableValuesContainer":{"type":"object","properties":{"integer":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__TableValuesIntegerValue"}},"keyword":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__TableValuesKeywordValue"}},"long":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__TableValuesLongValue"}},"double":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__TableValuesLongDouble"}}}},"esql._types__TableValuesIntegerValue":{"anyOf":[{"type":"number"},{"type":"array","items":{"type":"number"}}]},"esql._types__TableValuesKeywordValue":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"esql._types__TableValuesLongValue":{"anyOf":[{"type":"number"},{"type":"array","items":{"type":"number"}}]},"esql._types__TableValuesLongDouble":{"anyOf":[{"type":"number"},{"type":"array","items":{"type":"number"}}]},"esql._types__EsqlQuerySettings":{"type":"object","properties":{"time_zone":{"type":"string","description":"The default timezone to be used in the query.\nIt defaults to UTC and overrides the `time_zone` request parameter.","x-availability":{"stack":{"since":"9.4.0","stability":"stable"},"serverless":{"stability":"stable"}}},"approximation":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlApproximation","description":"Enables query approximation if possible for the query.\n`false` (the default) disables query approximation and `true` enables it with default settings.\nA map value enables query approximation with custom settings.","x-availability":{"stack":{"since":"9.5.0","stability":"stable"},"serverless":{"stability":"stable"}}},"column_metadata":{"$ref":"./_spec_utils.json#/$defs/_spec_utils__Stringified","description":"When enabled, column metadata is added to the query response as additional `_meta` properties.\nCurrently, only `_meta.bucket` is added for columns corresponding to the `BUCKET` function, containing the bucket interval and unit for queries where it can be determined.","x-availability":{"stack":{"since":"9.5.0","stability":"experimental"},"serverless":{"stability":"experimental"}}}},"description":"Per-query settings supplied through the request body.\nThis is the request-body equivalent of the in-query `SET` command.\nOnly settings that are exposed as request-body parameters can be set here; other `SET`-only\nsettings (such as `unmapped_fields`) must be supplied in the query itself."},"esql._types__EsqlApproximation":{"anyOf":[{"type":"boolean"},{"$ref":"./esql._types.json#/$defs/esql._types__EsqlApproximationSettings"}],"description":"The `approximation` query setting.\nIt can be a boolean that toggles query approximation with default settings, or a map that enables it with custom settings."},"esql._types__EsqlApproximationSettings":{"type":"object","properties":{"rows":{"type":"number","description":"The number of sampled rows used for approximating the query.\nIt must be at least 10,000. A null value uses the system default."},"confidence_level":{"type":"number","description":"The confidence level of the computed confidence intervals.\nA null value disables computing confidence intervals."}}},"esql._types__AsyncEsqlResult":{"type":"object","properties":{"took":{},"is_partial":{"type":"boolean"},"all_columns":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlColumnInfo"}},"columns":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlColumnInfo"}},"values":{"type":"array","items":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}},"_clusters":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlClusterInfo","description":"Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request\nand a cross-cluster search was performed."},"profile":{"description":"Profiling information. Present if `profile` was `true` in the request.\nThe contents of this field are currently unstable."},"id":{"type":"string","description":"The ID of the async query, to be used in subsequent requests to check the status or retrieve results.\n\nAlso available in the `X-Elasticsearch-Async-Id` HTTP header."},"is_running":{"type":"boolean","description":"Indicates whether the async query is still running or has completed.\n\nAlso available in the `X-Elasticsearch-Async-Is-Running` HTTP header."}},"required":["columns","values","is_running"]},"esql._types__EsqlColumnInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"esql._types__EsqlClusterInfo":{"type":"object","properties":{"total":{"type":"number"},"successful":{"type":"number"},"running":{"type":"number"},"skipped":{"type":"number"},"partial":{"type":"number"},"failed":{"type":"number"},"details":{"type":"object","additionalProperties":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlClusterDetails"}}},"required":["total","successful","running","skipped","partial","failed","details"]},"esql._types__EsqlClusterDetails":{"type":"object","properties":{"status":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlClusterStatus"},"indices":{"type":"string"},"took":{},"_shards":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlShardInfo"},"failures":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlShardFailure"}}},"required":["status","indices"]},"esql._types__EsqlClusterStatus":{"enum":["running","successful","partial","skipped","failed"]},"esql._types__EsqlShardInfo":{"type":"object","properties":{"total":{"type":"number"},"successful":{"type":"number"},"skipped":{"type":"number"},"failed":{"type":"number"}},"required":["total"]},"esql._types__EsqlShardFailure":{"type":"object","properties":{"shard":{"type":"number"},"index":{"anyOf":[{"type":"string"},{"type":"null"}]},"node":{"type":"string"},"reason":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}},"required":["shard","index","reason"]},"esql._types__EsqlResult":{"type":"object","properties":{"took":{},"is_partial":{"type":"boolean"},"all_columns":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlColumnInfo"}},"columns":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlColumnInfo"}},"values":{"type":"array","items":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}},"_clusters":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlClusterInfo","description":"Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request\nand a cross-cluster search was performed."},"profile":{"description":"Profiling information. Present if `profile` was `true` in the request.\nThe contents of this field are currently unstable."}},"required":["columns","values"]},"esql._types__ESQLView":{"type":"object","properties":{"name":{"type":"string","description":"The name of the ES|QL view"},"query":{"type":"string","description":"The ES|QL query"},"description":{"type":"string","description":"A free-text description of the view."}},"required":["name","query"],"description":"A non-materialized ES|QL view."}}}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"esql._types__EsqlFormat":{"enum":["csv","json","tsv","txt","yaml","cbor","smile","arrow"]},"esql._types__ESQLParams":{"anyOf":[{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__SingleOrMultiValue"}},{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__NamedValue"}}]},"esql._types__SingleOrMultiValue":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__FieldValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}]},"esql._types__NamedValue":{"type":"object","additionalProperties":{"$ref":"./esql._types.json#/$defs/esql._types__NamedParameterValue"},"minProperties":1,"maxProperties":1},"esql._types__NamedParameterValue":{"anyOf":[{"$ref":"./esql._types.json#/$defs/esql._types__SingleOrMultiValue"},{"$ref":"./esql._types.json#/$defs/esql._types__ClassifiedNamedParameter"}],"description":"The value of a named ES|QL query parameter.\nIt is either a literal single or multi value, or a single-key object that classifies how\nthe parameter is interpreted."},"esql._types__ClassifiedNamedParameter":{"type":"object","properties":{"value":{"$ref":"./esql._types.json#/$defs/esql._types__SingleOrMultiValue","description":"Interpret the parameter as a literal value."},"identifier":{"type":"string","description":"Interpret the parameter as an identifier, such as a field or function name."},"pattern":{"type":"string","description":"Interpret the parameter as a pattern, such as an index or field name pattern."}},"description":"A named ES|QL query parameter supplied in its classified form.\nExactly one of `value`, `identifier`, or `pattern` must be set."},"esql._types__TableValuesContainer":{"type":"object","properties":{"integer":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__TableValuesIntegerValue"}},"keyword":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__TableValuesKeywordValue"}},"long":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__TableValuesLongValue"}},"double":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__TableValuesLongDouble"}}}},"esql._types__TableValuesIntegerValue":{"anyOf":[{"type":"number"},{"type":"array","items":{"type":"number"}}]},"esql._types__TableValuesKeywordValue":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"esql._types__TableValuesLongValue":{"anyOf":[{"type":"number"},{"type":"array","items":{"type":"number"}}]},"esql._types__TableValuesLongDouble":{"anyOf":[{"type":"number"},{"type":"array","items":{"type":"number"}}]},"esql._types__EsqlQuerySettings":{"type":"object","properties":{"time_zone":{"type":"string","description":"The default timezone to be used in the query.\nIt defaults to UTC and overrides the `time_zone` request parameter.","x-availability":{"stack":{"since":"9.4.0","stability":"stable"},"serverless":{"stability":"stable"}}},"approximation":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlApproximation","description":"Enables query approximation if possible for the query.\n`false` (the default) disables query approximation and `true` enables it with default settings.\nA map value enables query approximation with custom settings.","x-availability":{"stack":{"since":"9.5.0","stability":"stable"},"serverless":{"stability":"stable"}}},"column_metadata":{"$ref":"./_spec_utils.json#/$defs/_spec_utils__Stringified","description":"When enabled, column metadata is added to the query response as additional `_meta` properties.\nCurrently, only `_meta.bucket` is added for columns corresponding to the `BUCKET` function, containing the bucket interval and unit for queries where it can be determined.","x-availability":{"stack":{"since":"9.5.0","stability":"experimental"},"serverless":{"stability":"experimental"}}}},"description":"Per-query settings supplied through the request body.\nThis is the request-body equivalent of the in-query `SET` command.\nOnly settings that are exposed as request-body parameters can be set here; other `SET`-only\nsettings (such as `unmapped_fields`) must be supplied in the query itself."},"esql._types__EsqlApproximation":{"anyOf":[{"type":"boolean"},{"$ref":"./esql._types.json#/$defs/esql._types__EsqlApproximationSettings"}],"description":"The `approximation` query setting.\nIt can be a boolean that toggles query approximation with default settings, or a map that enables it with custom settings."},"esql._types__EsqlApproximationSettings":{"type":"object","properties":{"rows":{"type":"number","description":"The number of sampled rows used for approximating the query.\nIt must be at least 10,000. A null value uses the system default."},"confidence_level":{"type":"number","description":"The confidence level of the computed confidence intervals.\nA null value disables computing confidence intervals."}}},"esql._types__AsyncEsqlResult":{"type":"object","properties":{"took":{},"is_partial":{"type":"boolean"},"all_columns":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlColumnInfo"}},"columns":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlColumnInfo"}},"values":{"type":"array","items":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}},"_clusters":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlClusterInfo","description":"Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request\nand a cross-cluster search was performed."},"profile":{"description":"Profiling information. Present if `profile` was `true` in the request.\nThe contents of this field are currently unstable."},"id":{"type":"string","description":"The ID of the async query, to be used in subsequent requests to check the status or retrieve results.\n\nAlso available in the `X-Elasticsearch-Async-Id` HTTP header."},"is_running":{"type":"boolean","description":"Indicates whether the async query is still running or has completed.\n\nAlso available in the `X-Elasticsearch-Async-Is-Running` HTTP header."}},"required":["columns","values","is_running"]},"esql._types__EsqlColumnInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"esql._types__EsqlClusterInfo":{"type":"object","properties":{"total":{"type":"number"},"successful":{"type":"number"},"running":{"type":"number"},"skipped":{"type":"number"},"partial":{"type":"number"},"failed":{"type":"number"},"details":{"type":"object","additionalProperties":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlClusterDetails"}}},"required":["total","successful","running","skipped","partial","failed","details"]},"esql._types__EsqlClusterDetails":{"type":"object","properties":{"status":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlClusterStatus"},"indices":{"type":"string"},"took":{},"_shards":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlShardInfo"},"failures":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlShardFailure"}}},"required":["status","indices"]},"esql._types__EsqlClusterStatus":{"enum":["running","successful","partial","skipped","failed"]},"esql._types__EsqlShardInfo":{"type":"object","properties":{"total":{"type":"number"},"successful":{"type":"number"},"skipped":{"type":"number"},"failed":{"type":"number"}},"required":["total"]},"esql._types__EsqlShardFailure":{"type":"object","properties":{"shard":{"type":"number"},"index":{"anyOf":[{"type":"string"},{"type":"null"}]},"node":{"type":"string"},"reason":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}},"required":["shard","index","reason"]},"esql._types__EsqlResult":{"type":"object","properties":{"took":{},"is_partial":{"type":"boolean"},"all_columns":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlColumnInfo"}},"columns":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlColumnInfo"}},"values":{"type":"array","items":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}},"_clusters":{"$ref":"./esql._types.json#/$defs/esql._types__EsqlClusterInfo","description":"Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request\nand a cross-cluster search was performed."},"profile":{"description":"Profiling information. Present if `profile` was `true` in the request.\nThe contents of this field are currently unstable."}},"required":["columns","values"]},"esql._types__ESQLDataSource":{"type":"object","properties":{"name":{"type":"string","description":"The data source name."},"type":{"type":"string","description":"The data source type. Currently, `s3` is supported."},"description":{"type":"string","description":"A free-text description."},"settings":{"type":"object","additionalProperties":{},"description":"Type-specific connection and authentication settings."}},"required":["name","type","settings"],"description":"Represents a data source definition stored in cluster state. A data source holds\nconnection settings (credentials, endpoints, auth) for an external data provider."},"esql._types__ESQLDataset":{"type":"object","properties":{"name":{"type":"string","description":"The dataset name."},"data_source":{"type":"string","description":"The name of the referenced data source."},"resource":{"type":"string","description":"The URI that identifies the data to read, resolved against the referenced data source.\nIt can include glob patterns, for example a recursive pattern that matches\nParquet files under `s3://logs-bucket/access`."},"description":{"type":"string","description":"A free-text description."},"settings":{"type":"object","additionalProperties":{},"description":"Format- and parsing-specific settings that configure how the resource is read.\nCommon keys include `format` and `partition_detection`. Additional keys depend on the format reader;\ncompression can be inferred from the resource URI."},"mappings":{"$ref":"./esql._types.json#/$defs/esql._types__DatasetMapping","description":"The user-declared mapping on the dataset definition."}},"required":["name","data_source","resource"],"description":"Represents a dataset definition stored in cluster state. A dataset is a named reference\nto external data that participates in the index namespace alongside indices, aliases, and views.\nDatasets inherit credentials from their referenced data source at query time."},"esql._types__DatasetMapping":{"type":"object","properties":{"dynamic":{"$ref":"./esql._types.json#/$defs/esql._types__Dynamic","description":"The policy for columns that are not declared in `properties`.\n`true` (the default) infers undeclared columns and overlays the declarations; `false` makes the declaration the entire schema, so undeclared columns are not queryable."},"properties":{"type":"object","additionalProperties":{"$ref":"./esql._types.json#/$defs/esql._types__DatasetFieldMapping"},"description":"The per-column declarations, keyed by logical column name."},"_id":{"$ref":"./esql._types.json#/$defs/esql._types__IdPath","description":"The `_id` meta-field configuration, sourcing the document identity from a column."}},"description":"A user-declared mapping (the `mappings` block) attached to a dataset.\nIt is entirely optional: a dataset with no declared mapping relies on inference."},"esql._types__Dynamic":{"enum":["true","false"]},"esql._types__DatasetFieldMapping":{"type":"object","properties":{"type":{"type":"string","description":"The declared column type."},"path":{"type":"string","description":"The underlying file column that this logical column reads from.\nThis is a read-path rename: the physical column becomes this single logical column."},"format":{"type":"string","description":"The date-parse pattern for a declared `date` column, mirroring the index date-field `format`."}},"required":["type"],"description":"A per-column declaration inside a dataset mapping's `properties`."},"esql._types__IdPath":{"type":"object","properties":{"path":{"type":"string","description":"The name of the column that provides the document identity."}},"required":["path"],"description":"The `_id` meta-field of a dataset mapping."},"esql._types__ESQLView":{"type":"object","properties":{"name":{"type":"string","description":"The name of the ES|QL view"},"query":{"type":"string","description":"The ES|QL query"},"description":{"type":"string","description":"A free-text description of the view."}},"required":["name","query"],"description":"A non-materialized ES|QL view."}}}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.delete_data_source","description":"Delete ES|QL data sources.\n\nDeletes one or more data sources used in ES|QL data federation.\nFails with `409` if any dataset references one of the named data sources;\ndelete the dependent datasets first.","x-api":{"id":"esql.delete_data_source","name":"delete-data-source","namespace":"esql"},"x-method":"DELETE","x-path":"/_query/data_source/{name}","x-urls":[{"path":"/_query/data_source/{name}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the request to be completed.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of data source names to delete.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["name"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.delete_data_source","x-api":{"id":"esql.delete_data_source","name":"delete-data-source","namespace":"esql"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.delete_dataset","description":"Delete ES|QL datasets.\n\nDeletes one or more datasets used in ES|QL data federation.\nIf any specified dataset does not exist, the request fails and no datasets are deleted.","x-api":{"id":"esql.delete_dataset","name":"delete-dataset","namespace":"esql"},"x-method":"DELETE","x-path":"/_query/dataset/{name}","x-urls":[{"path":"/_query/dataset/{name}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the request to be completed.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of dataset names to delete.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["name"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.delete_dataset","x-api":{"id":"esql.delete_dataset","name":"delete-dataset","namespace":"esql"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.get_data_source","description":"Get ES|QL data sources.\n\nReturns one or more data sources used in ES|QL data federation.\nA concrete-name miss returns `404`; a wildcard pattern or list-all request with no match\nreturns `200` with an empty array.","x-api":{"id":"esql.get_data_source","name":"get-data-source","namespace":"esql"},"x-method":"GET","x-path":"/_query/data_source/{name}","x-urls":[{"path":"/_query/data_source","methods":["GET"]},{"path":"/_query/data_source/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of data source names or wildcard patterns. Omit to return all data sources.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.get_data_source","x-api":{"id":"esql.get_data_source","name":"get-data-source","namespace":"esql"},"type":"object","properties":{"data_sources":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__ESQLDataSource"},"description":"The matching data sources.\nCredential values in each data source's settings are redacted as `::es_redacted::` in the response."}},"required":["data_sources"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.get_dataset","description":"Get ES|QL datasets.\n\nReturns one or more datasets used in ES|QL data federation.\nA concrete-name miss returns `404`; a wildcard pattern or list-all request with no match\nreturns `200` with an empty array.","x-api":{"id":"esql.get_dataset","name":"get-dataset","namespace":"esql"},"x-method":"GET","x-path":"/_query/dataset/{name}","x-urls":[{"path":"/_query/dataset","methods":["GET"]},{"path":"/_query/dataset/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of dataset names or wildcard patterns. Omit to return all datasets.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.get_dataset","x-api":{"id":"esql.get_dataset","name":"get-dataset","namespace":"esql"},"type":"object","properties":{"datasets":{"type":"array","items":{"$ref":"./esql._types.json#/$defs/esql._types__ESQLDataset"},"description":"The matching datasets."}},"required":["datasets"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.put_data_source","description":"Create or update an ES|QL data source.\n\nCreates or replaces a named, type-specific data source configuration for ES|QL data federation.\nDatasets reference data source configurations to access external data. Names must be lowercase\nand follow index or alias naming rules.","x-api":{"id":"esql.put_data_source","name":"put-data-source","namespace":"esql"},"x-method":"PUT","x-path":"/_query/data_source/{name}","x-urls":[{"path":"/_query/data_source/{name}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the request to be completed.","x-found-in":"query"},"type":{"type":"string","description":"The data source type. Currently, `s3` is supported.\nThe value must be lowercase and contain no whitespace.","x-found-in":"body"},"description":{"type":"string","description":"A free-text description of the data source.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Type-specific connection and authentication settings.\nFor `s3`, connection settings include `region` and `endpoint`. Authentication settings\ninclude `auth` and the credentials required by the selected authentication method.","x-found-in":"body"},"name":{"type":"string","description":"The data source name to create or update.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["name","type"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.put_data_source","x-api":{"id":"esql.put_data_source","name":"put-data-source","namespace":"esql"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.put_dataset","description":"Create or update an ES|QL dataset.\n\nCreates or replaces a dataset that references a data source in ES|QL data federation.\nDataset names participate in the index namespace and must follow index or alias naming rules.\nReturns `404` if the referenced data source does not exist.","x-api":{"id":"esql.put_dataset","name":"put-dataset","namespace":"esql"},"x-method":"PUT","x-path":"/_query/dataset/{name}","x-urls":[{"path":"/_query/dataset/{name}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the request to be completed.","x-found-in":"query"},"data_source":{"type":"string","description":"The name of the referenced data source. The data source must already exist.","x-found-in":"body"},"resource":{"type":"string","description":"The URI that identifies the data to read, resolved against the referenced data source.\nIt can include glob patterns. For example, a recursive pattern can match\nall Parquet files under the `s3://logs-bucket/access` prefix.","x-found-in":"body"},"description":{"type":"string","description":"A free-text description of the dataset.","x-found-in":"body"},"mappings":{"$ref":"./esql._types.json#/$defs/esql._types__DatasetMapping","description":"User-declared mapping on the dataset definition","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Format and parsing-specific settings that configure how the resource is read.\nCommon keys include `format`, which explicitly selects a registered format, and\n`partition_detection`, which accepts `auto`, `hive`, `template`, or `none`. Additional\nkeys depend on the format reader. Compression can be inferred from the resource URI.","x-found-in":"body"},"name":{"type":"string","description":"The dataset name to create or update.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["name","data_source","resource"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"esql.put_dataset","x-api":{"id":"esql.put_dataset","name":"put-dataset","namespace":"esql"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete-streams-name-queries-queryid","x-api":{"id":"streams.delete-streams-name-queries-queryid","name":"delete-streams-name-queries-queryid","namespace":"streams"},"x-method":"DELETE","x-path":"/api/streams/{name}/queries/{queryId}","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"x-deprecated":{},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"},"queryId":{"type":"string","description":"The identifier of the query to remove.","x-found-in":"path"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete-streams-name-queries-queryid","x-api":{"id":"streams.delete-streams-name-queries-queryid","name":"delete-streams-name-queries-queryid","namespace":"streams"},"x-method":"DELETE","x-path":"/api/streams/{name}/queries/{queryId}","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"x-deprecated":{},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"},"queryId":{"type":"string","description":"The identifier of the query to remove.","x-found-in":"path"}},"required":["name","queryId"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete-streams-name","x-api":{"id":"streams.delete-streams-name","name":"delete-streams-name","namespace":"streams"},"x-method":"DELETE","x-path":"/api/streams/{name}","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete-streams-name","x-api":{"id":"streams.delete-streams-name","name":"delete-streams-name","namespace":"streams"},"x-method":"DELETE","x-path":"/api/streams/{name}","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"}},"required":["name"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete-streams-streamname-attachments-attachmenttype-attachmentid","x-api":{"id":"streams.delete-streams-streamname-attachments-attachmenttype-attachmentid","name":"delete-streams-streamname-attachments-attachmenttype-attachmentid","namespace":"streams"},"x-method":"DELETE","x-path":"/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId}","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"streamName":{"type":"string","description":"The name of the stream","x-found-in":"path"},"attachmentType":{"type":"string","description":"The type of the attachment","x-found-in":"path"},"attachmentId":{"type":"string","description":"The ID of the attachment","x-found-in":"path"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete-streams-streamname-attachments-attachmenttype-attachmentid","x-api":{"id":"streams.delete-streams-streamname-attachments-attachmenttype-attachmentid","name":"delete-streams-streamname-attachments-attachmenttype-attachmentid","namespace":"streams"},"x-method":"DELETE","x-path":"/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId}","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"streamName":{"type":"string","description":"The name of the stream","x-found-in":"path"},"attachmentType":{"type":"string","description":"The type of the attachment","x-found-in":"path"},"attachmentId":{"type":"string","description":"The ID of the attachment","x-found-in":"path"}},"required":["streamName","attachmentType","attachmentId"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name-ingest","x-api":{"id":"streams.get-streams-name-ingest","name":"get-streams-name-ingest","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}/_ingest","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name-ingest","x-api":{"id":"streams.get-streams-name-ingest","name":"get-streams-name-ingest","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}/_ingest","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"}},"required":["name"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name-queries","x-api":{"id":"streams.get-streams-name-queries","name":"get-streams-name-queries","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}/queries","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"x-deprecated":{},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name-queries","x-api":{"id":"streams.get-streams-name-queries","name":"get-streams-name-queries","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}/queries","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"x-deprecated":{},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"}},"required":["name"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name-query","x-api":{"id":"streams.get-streams-name-query","name":"get-streams-name-query","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}/_query","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the query stream.","x-found-in":"path"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name-query","x-api":{"id":"streams.get-streams-name-query","name":"get-streams-name-query","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}/_query","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the query stream.","x-found-in":"path"}},"required":["name"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name-significant-events","x-api":{"id":"streams.get-streams-name-significant-events","name":"get-streams-name-significant-events","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}/significant_events","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"x-deprecated":{},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"},"from":{"type":"string","description":"Start of the time range as an ISO 8601 date string.","x-found-in":"query"},"to":{"type":"string","description":"End of the time range as an ISO 8601 date string.","x-found-in":"query"},"bucketSize":{"type":"string","description":"The bucket size for aggregating events (e.g. \"1m\", \"1h\").","x-found-in":"query"},"query":{"type":"string","description":"Query string to filter significant events on metadata fields","x-found-in":"query"},"searchMode":{"enum":["keyword","semantic","hybrid"],"description":"Search mode: keyword (BM25), semantic (vector), or hybrid (RRF). When omitted, defaults to hybrid with a silent keyword fallback on failure. When set explicitly, failures propagate as errors.","x-found-in":"query"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name-significant-events","x-api":{"id":"streams.get-streams-name-significant-events","name":"get-streams-name-significant-events","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}/significant_events","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"x-deprecated":{},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"},"from":{"type":"string","description":"Start of the time range as an ISO 8601 date string.","x-found-in":"query"},"to":{"type":"string","description":"End of the time range as an ISO 8601 date string.","x-found-in":"query"},"bucketSize":{"type":"string","description":"The bucket size for aggregating events (e.g. \"1m\", \"1h\").","x-found-in":"query"},"query":{"type":"string","description":"Query string to filter significant events on metadata fields","x-found-in":"query"},"searchMode":{"enum":["keyword","semantic","hybrid"],"description":"Search mode: keyword (BM25), semantic (vector), or hybrid (RRF). When omitted, defaults to hybrid with a silent keyword fallback on failure. When set explicitly, failures propagate as errors.","x-found-in":"query"}},"required":["name","from","to","bucketSize"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name","x-api":{"id":"streams.get-streams-name","name":"get-streams-name","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-name","x-api":{"id":"streams.get-streams-name","name":"get-streams-name","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{name}","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the stream.","x-found-in":"path"}},"required":["name"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-streamname-attachments","x-api":{"id":"streams.get-streams-streamname-attachments","name":"get-streams-streamname-attachments","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{streamName}/attachments","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"streamName":{"type":"string","description":"The name of the stream","x-found-in":"path"},"query":{"type":"string","description":"Search query to filter attachments by title","x-found-in":"query"},"attachmentTypes":{"type":"array","items":{"enum":["dashboard","rule","slo"]},"description":"Filter by attachment types (single value or array)","x-found-in":"query"},"tags":{"type":"array","items":{"type":"string"},"description":"Filter by tags (single value or array)","x-found-in":"query"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams-streamname-attachments","x-api":{"id":"streams.get-streams-streamname-attachments","name":"get-streams-streamname-attachments","namespace":"streams"},"x-method":"GET","x-path":"/api/streams/{streamName}/attachments","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"streamName":{"type":"string","description":"The name of the stream","x-found-in":"path"},"query":{"type":"string","description":"Search query to filter attachments by title","x-found-in":"query"},"attachmentTypes":{"type":"array","items":{"enum":["dashboard","rule","slo"]},"description":"Filter by attachment types (single value or array)","x-found-in":"query"},"tags":{"type":"array","items":{"type":"string"},"description":"Filter by tags (single value or array)","x-found-in":"query"}},"required":["streamName"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams","x-api":{"id":"streams.get-streams","name":"get-streams","namespace":"streams"},"x-method":"GET","x-path":"/api/streams","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-streams","x-api":{"id":"streams.get-streams","name":"get-streams","namespace":"streams"},"x-method":"GET","x-path":"/api/streams","x-destructive":false,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"post-streams-disable","x-api":{"id":"streams.post-streams-disable","name":"post-streams-disable","namespace":"streams"},"x-method":"POST","x-path":"/api/streams/_disable","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"post-streams-disable","x-api":{"id":"streams.post-streams-disable","name":"post-streams-disable","namespace":"streams"},"x-method":"POST","x-path":"/api/streams/_disable","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"post-streams-enable","x-api":{"id":"streams.post-streams-enable","name":"post-streams-enable","namespace":"streams"},"x-method":"POST","x-path":"/api/streams/_enable","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"post-streams-enable","x-api":{"id":"streams.post-streams-enable","name":"post-streams-enable","namespace":"streams"},"x-method":"POST","x-path":"/api/streams/_enable","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"post-streams-resync","x-api":{"id":"streams.post-streams-resync","name":"post-streams-resync","namespace":"streams"},"x-method":"POST","x-path":"/api/streams/_resync","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"post-streams-resync","x-api":{"id":"streams.post-streams-resync","name":"post-streams-resync","namespace":"streams"},"x-method":"POST","x-path":"/api/streams/_resync","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"put-streams-streamname-attachments-attachmenttype-attachmentid","x-api":{"id":"streams.put-streams-streamname-attachments-attachmenttype-attachmentid","name":"put-streams-streamname-attachments-attachmenttype-attachmentid","namespace":"streams"},"x-method":"PUT","x-path":"/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId}","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"streamName":{"type":"string","description":"The name of the stream","x-found-in":"path"},"attachmentType":{"type":"string","description":"The type of the attachment","x-found-in":"path"},"attachmentId":{"type":"string","description":"The ID of the attachment","x-found-in":"path"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"put-streams-streamname-attachments-attachmenttype-attachmentid","x-api":{"id":"streams.put-streams-streamname-attachments-attachmenttype-attachmentid","name":"put-streams-streamname-attachments-attachmenttype-attachmentid","namespace":"streams"},"x-method":"PUT","x-path":"/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId}","x-destructive":true,"x-availability":{"serverless":{"stability":"experimental"}},"type":"object","properties":{"streamName":{"type":"string","description":"The name of the stream","x-found-in":"path"},"attachmentType":{"type":"string","description":"The type of the attachment","x-found-in":"path"},"attachmentId":{"type":"string","description":"The ID of the attachment","x-found-in":"path"}},"required":["streamName","attachmentType","attachmentId"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"createElasticsearchProject","x-api":{"id":"elasticsearch-projects.create-elasticsearch-project","name":"create-elasticsearch-project","namespace":"elasticsearch-projects"},"x-method":"POST","x-path":"/api/v1/serverless/projects/elasticsearch","x-destructive":true,"type":"object","properties":{"name":{"type":"string","x-found-in":"body"},"alias":{"type":"string","x-found-in":"body"},"region_id":{"type":"string","x-found-in":"body"},"optimized_for":{"enum":["general_purpose","vector"],"x-found-in":"body"},"search_lake":{"type":"object","properties":{"search_power":{"type":"number"},"boost_window":{"type":"number"}},"x-found-in":"body"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-found-in":"body"},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["type"],"additionalProperties":false}}},"required":["projects"],"additionalProperties":false,"x-found-in":"body"},"metadata":{"type":"object","properties":{"tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["tags"],"x-found-in":"body"}},"required":["name","region_id"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"createElasticsearchProject","x-api":{"id":"elasticsearch-projects.create-elasticsearch-project","name":"create-elasticsearch-project","namespace":"elasticsearch-projects"},"x-method":"POST","x-path":"/api/v1/serverless/projects/elasticsearch","x-destructive":true,"type":"object","properties":{"name":{"type":"string","x-found-in":"body"},"alias":{"type":"string","x-found-in":"body"},"region_id":{"type":"string","x-found-in":"body"},"optimized_for":{"enum":["general_purpose","vector"],"x-found-in":"body"},"search_lake":{"type":"object","properties":{"search_power":{"type":"number"},"boost_window":{"type":"number"}},"x-found-in":"body"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-found-in":"body"},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["type"],"additionalProperties":false},"minProperties":1}},"required":["projects"],"additionalProperties":false,"x-found-in":"body"},"metadata":{"type":"object","properties":{"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1}},"required":["tags"],"x-found-in":"body"}},"required":["name","region_id"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"createObservabilityProject","x-api":{"id":"observability-projects.create-observability-project","name":"create-observability-project","namespace":"observability-projects"},"x-method":"POST","x-path":"/api/v1/serverless/projects/observability","x-destructive":true,"type":"object","properties":{"name":{"type":"string","x-found-in":"body"},"alias":{"type":"string","x-found-in":"body"},"region_id":{"type":"string","x-found-in":"body"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-found-in":"body"},"product_tier":{"enum":["complete","logs_essentials"],"x-found-in":"body"},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["type"],"additionalProperties":false}}},"required":["projects"],"additionalProperties":false,"x-found-in":"body"},"metadata":{"type":"object","properties":{"tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["tags"],"x-found-in":"body"}},"required":["name","region_id"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"createObservabilityProject","x-api":{"id":"observability-projects.create-observability-project","name":"create-observability-project","namespace":"observability-projects"},"x-method":"POST","x-path":"/api/v1/serverless/projects/observability","x-destructive":true,"type":"object","properties":{"name":{"type":"string","x-found-in":"body"},"alias":{"type":"string","x-found-in":"body"},"region_id":{"type":"string","x-found-in":"body"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-found-in":"body"},"product_tier":{"enum":["complete","logs_essentials"],"x-found-in":"body"},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["type"],"additionalProperties":false},"minProperties":1}},"required":["projects"],"additionalProperties":false,"x-found-in":"body"},"metadata":{"type":"object","properties":{"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1}},"required":["tags"],"x-found-in":"body"}},"required":["name","region_id"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"createSecurityProject","x-api":{"id":"security-projects.create-security-project","name":"create-security-project","namespace":"security-projects"},"x-method":"POST","x-path":"/api/v1/serverless/projects/security","x-destructive":true,"type":"object","properties":{"name":{"type":"string","x-found-in":"body"},"alias":{"type":"string","x-found-in":"body"},"region_id":{"type":"string","x-found-in":"body"},"admin_features_package":{"enum":["standard","enterprise"],"x-found-in":"body"},"product_types":{"type":"array","items":{"type":"object","properties":{"product_line":{"enum":["security","cloud","endpoint"]},"product_tier":{"enum":["complete","essentials"]}},"required":["product_line","product_tier"]},"x-found-in":"body"},"search_lake":{"type":"object","properties":{"data_retention":{"oneOf":[{"type":"object","properties":{"max_retention_days":{"oneOf":[{"type":"number"},{"type":"null"}]},"default_retention_days":{"oneOf":[{"type":"number"},{"type":"null"}]}}},{"type":"null"}]}},"x-found-in":"body"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-found-in":"body"},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["type"],"additionalProperties":false}}},"required":["projects"],"additionalProperties":false,"x-found-in":"body"},"metadata":{"type":"object","properties":{"tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["tags"],"x-found-in":"body"}},"required":["name","region_id"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"createSecurityProject","x-api":{"id":"security-projects.create-security-project","name":"create-security-project","namespace":"security-projects"},"x-method":"POST","x-path":"/api/v1/serverless/projects/security","x-destructive":true,"type":"object","properties":{"name":{"type":"string","x-found-in":"body"},"alias":{"type":"string","x-found-in":"body"},"region_id":{"type":"string","x-found-in":"body"},"admin_features_package":{"enum":["standard","enterprise"],"x-found-in":"body"},"product_types":{"type":"array","items":{"type":"object","properties":{"product_line":{"enum":["security","cloud","endpoint"]},"product_tier":{"enum":["complete","essentials"]}},"required":["product_line","product_tier"]},"x-found-in":"body"},"search_lake":{"type":"object","properties":{"data_retention":{"oneOf":[{"type":"object","properties":{"max_retention_days":{"oneOf":[{"type":"number"},{"type":"null"}]},"default_retention_days":{"oneOf":[{"type":"number"},{"type":"null"}]}}},{"type":"null"}]}},"x-found-in":"body"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-found-in":"body"},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["type"],"additionalProperties":false},"minProperties":1}},"required":["projects"],"additionalProperties":false,"x-found-in":"body"},"metadata":{"type":"object","properties":{"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1}},"required":["tags"],"x-found-in":"body"}},"required":["name","region_id"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getElasticsearchProject","x-api":{"id":"elasticsearch-projects.get-elasticsearch-project","name":"get-elasticsearch-project","namespace":"elasticsearch-projects"},"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"region_id":{"type":"string"},"metadata":{"type":"object","properties":{"created_at":{"type":"string"},"created_by":{"type":"string"},"organization_id":{"type":"string"},"suspended_at":{"type":"string"},"suspended_reason":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"system_tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["created_at","created_by","organization_id"]},"cloud_id":{"type":"string"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"enum":["enabled","suspended","deleted"]},"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["status","type"]}}},"required":["projects"],"additionalProperties":false},"type":{"enum":["elasticsearch"]},"optimized_for":{"enum":["general_purpose","vector"]},"search_lake":{"type":"object","properties":{"search_power":{"type":"number"},"boost_window":{"type":"number"}}},"endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"}},"required":["elasticsearch","kibana"]},"private_endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"}},"required":["elasticsearch","kibana"]}},"required":["id","name","alias","region_id","metadata","cloud_id","type","optimized_for","endpoints"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getElasticsearchProject","x-api":{"id":"elasticsearch-projects.get-elasticsearch-project","name":"get-elasticsearch-project","namespace":"elasticsearch-projects"},"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"region_id":{"type":"string"},"metadata":{"type":"object","properties":{"created_at":{"type":"string"},"created_by":{"type":"string"},"organization_id":{"type":"string"},"suspended_at":{"type":"string"},"suspended_reason":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1},"system_tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["created_at","created_by","organization_id"]},"cloud_id":{"type":"string"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"enum":["enabled","suspended","deleted"]},"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["status","type"]}}},"required":["projects"],"additionalProperties":false},"type":{"enum":["elasticsearch"]},"optimized_for":{"enum":["general_purpose","vector"]},"search_lake":{"type":"object","properties":{"search_power":{"type":"number"},"boost_window":{"type":"number"}}},"endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"}},"required":["elasticsearch","kibana"]},"private_endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"}},"required":["elasticsearch","kibana"]}},"required":["id","name","alias","region_id","metadata","cloud_id","type","optimized_for","endpoints"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getElasticsearchProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-elasticsearch-project-link-candidates","name":"get-elasticsearch-project-link-candidates","namespace":"linked-candidate-projects"},"x-method":"GET","x-path":"/api/v1/serverless/projects/elasticsearch/{id}/link-candidates","x-destructive":false,"type":"object","properties":{"id":{"type":"string","description":"The ID of the project","x-found-in":"path"},"types":{"type":"array","description":"One or more types of projects to return as link candidates.","x-found-in":"query"},"csp":{"type":"string","description":"The Cloud Service Provider to filter the link candidate projects by.","x-found-in":"query"},"region":{"type":"string","description":"The region to filter the link candidate projects by.","x-found-in":"query"},"name":{"type":"string","description":"The project name to filter the link candidates by.","x-found-in":"query"},"alias":{"type":"string","description":"The project alias to filter the link candidates by.","x-found-in":"query"},"tags":{"type":"object","description":"If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.","x-found-in":"query"}},"required":["id"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getElasticsearchProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-elasticsearch-project-link-candidates","name":"get-elasticsearch-project-link-candidates","namespace":"linked-candidate-projects"},"x-method":"GET","x-path":"/api/v1/serverless/projects/elasticsearch/{id}/link-candidates","x-destructive":false,"type":"object","properties":{"id":{"type":"string","description":"The ID of the project","x-found-in":"path"},"types":{"type":"array","items":{"enum":["elasticsearch","observability","security","vectordb"]},"description":"One or more types of projects to return as link candidates.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"csp":{"type":"string","description":"The Cloud Service Provider to filter the link candidate projects by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"region":{"type":"string","description":"The region to filter the link candidate projects by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"name":{"type":"string","description":"The project name to filter the link candidates by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"alias":{"type":"string","description":"The project alias to filter the link candidates by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1,"description":"If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.","x-found-in":"query","x-query-serialization":{"style":"deepObject","explode":true}}},"required":["id"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getElasticsearchProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-elasticsearch-project-link-candidates","name":"get-elasticsearch-project-link-candidates","namespace":"linked-candidate-projects"},"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"type":{"enum":["elasticsearch","observability","security","vectordb"]},"csp":{"type":"string"},"region":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"linked":{"type":"boolean"}},"required":["id","name","alias","type","csp","region","tags","linked"]}}},"required":["items"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getElasticsearchProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-elasticsearch-project-link-candidates","name":"get-elasticsearch-project-link-candidates","namespace":"linked-candidate-projects"},"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"type":{"enum":["elasticsearch","observability","security","vectordb"]},"csp":{"type":"string"},"region":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1},"linked":{"type":"boolean"}},"required":["id","name","alias","type","csp","region","tags","linked"]}}},"required":["items"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getObservabilityProject","x-api":{"id":"observability-projects.get-observability-project","name":"get-observability-project","namespace":"observability-projects"},"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"region_id":{"type":"string"},"metadata":{"type":"object","properties":{"created_at":{"type":"string"},"created_by":{"type":"string"},"organization_id":{"type":"string"},"suspended_at":{"type":"string"},"suspended_reason":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"system_tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["created_at","created_by","organization_id"]},"cloud_id":{"type":"string"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"enum":["enabled","suspended","deleted"]},"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["status","type"]}}},"required":["projects"],"additionalProperties":false},"type":{"enum":["observability"]},"product_tier":{"enum":["complete","logs_essentials"]},"endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"},"apm":{"type":"string"},"ingest":{"type":"string"}},"required":["elasticsearch","kibana","apm","ingest"]},"private_endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"},"apm":{"type":"string"},"ingest":{"type":"string"}},"required":["elasticsearch","kibana","apm","ingest"]}},"required":["id","name","alias","region_id","metadata","cloud_id","type","endpoints"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getObservabilityProject","x-api":{"id":"observability-projects.get-observability-project","name":"get-observability-project","namespace":"observability-projects"},"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"region_id":{"type":"string"},"metadata":{"type":"object","properties":{"created_at":{"type":"string"},"created_by":{"type":"string"},"organization_id":{"type":"string"},"suspended_at":{"type":"string"},"suspended_reason":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1},"system_tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["created_at","created_by","organization_id"]},"cloud_id":{"type":"string"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"enum":["enabled","suspended","deleted"]},"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["status","type"]}}},"required":["projects"],"additionalProperties":false},"type":{"enum":["observability"]},"product_tier":{"enum":["complete","logs_essentials"]},"endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"},"apm":{"type":"string"},"ingest":{"type":"string"}},"required":["elasticsearch","kibana","apm","ingest"]},"private_endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"},"apm":{"type":"string"},"ingest":{"type":"string"}},"required":["elasticsearch","kibana","apm","ingest"]}},"required":["id","name","alias","region_id","metadata","cloud_id","type","endpoints"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getObservabilityProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-observability-project-link-candidates","name":"get-observability-project-link-candidates","namespace":"linked-candidate-projects"},"x-method":"GET","x-path":"/api/v1/serverless/projects/observability/{id}/link-candidates","x-destructive":false,"type":"object","properties":{"id":{"type":"string","description":"The ID of the project","x-found-in":"path"},"types":{"type":"array","description":"One or more types of projects to return as link candidates.","x-found-in":"query"},"csp":{"type":"string","description":"The Cloud Service Provider to filter the link candidate projects by.","x-found-in":"query"},"region":{"type":"string","description":"The region to filter the link candidate projects by.","x-found-in":"query"},"name":{"type":"string","description":"The project name to filter the link candidates by.","x-found-in":"query"},"alias":{"type":"string","description":"The project alias to filter the link candidates by.","x-found-in":"query"},"tags":{"type":"object","description":"If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.","x-found-in":"query"}},"required":["id"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getObservabilityProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-observability-project-link-candidates","name":"get-observability-project-link-candidates","namespace":"linked-candidate-projects"},"x-method":"GET","x-path":"/api/v1/serverless/projects/observability/{id}/link-candidates","x-destructive":false,"type":"object","properties":{"id":{"type":"string","description":"The ID of the project","x-found-in":"path"},"types":{"type":"array","items":{"enum":["elasticsearch","observability","security","vectordb"]},"description":"One or more types of projects to return as link candidates.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"csp":{"type":"string","description":"The Cloud Service Provider to filter the link candidate projects by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"region":{"type":"string","description":"The region to filter the link candidate projects by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"name":{"type":"string","description":"The project name to filter the link candidates by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"alias":{"type":"string","description":"The project alias to filter the link candidates by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1,"description":"If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.","x-found-in":"query","x-query-serialization":{"style":"deepObject","explode":true}}},"required":["id"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getObservabilityProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-observability-project-link-candidates","name":"get-observability-project-link-candidates","namespace":"linked-candidate-projects"},"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"type":{"enum":["elasticsearch","observability","security","vectordb"]},"csp":{"type":"string"},"region":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"linked":{"type":"boolean"}},"required":["id","name","alias","type","csp","region","tags","linked"]}}},"required":["items"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getObservabilityProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-observability-project-link-candidates","name":"get-observability-project-link-candidates","namespace":"linked-candidate-projects"},"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"type":{"enum":["elasticsearch","observability","security","vectordb"]},"csp":{"type":"string"},"region":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1},"linked":{"type":"boolean"}},"required":["id","name","alias","type","csp","region","tags","linked"]}}},"required":["items"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getSecurityProject","x-api":{"id":"security-projects.get-security-project","name":"get-security-project","namespace":"security-projects"},"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"region_id":{"type":"string"},"metadata":{"type":"object","properties":{"created_at":{"type":"string"},"created_by":{"type":"string"},"organization_id":{"type":"string"},"suspended_at":{"type":"string"},"suspended_reason":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"system_tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["created_at","created_by","organization_id"]},"cloud_id":{"type":"string"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"enum":["enabled","suspended","deleted"]},"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["status","type"]}}},"required":["projects"],"additionalProperties":false},"type":{"enum":["security"]},"endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"},"ingest":{"type":"string"}},"required":["elasticsearch","kibana","ingest"]},"private_endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"},"ingest":{"type":"string"}},"required":["elasticsearch","kibana","ingest"]},"search_lake":{"type":"object","properties":{"data_retention":{"oneOf":[{"type":"object","properties":{"max_retention_days":{"oneOf":[{"type":"number"},{"type":"null"}]},"default_retention_days":{"oneOf":[{"type":"number"},{"type":"null"}]}}},{"type":"null"}]}}},"admin_features_package":{"enum":["standard","enterprise"]},"product_types":{"type":"array","items":{"type":"object","properties":{"product_line":{"enum":["security","cloud","endpoint"]},"product_tier":{"enum":["complete","essentials"]}},"required":["product_line","product_tier"]}}},"required":["id","name","alias","region_id","metadata","cloud_id","type","endpoints"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getSecurityProject","x-api":{"id":"security-projects.get-security-project","name":"get-security-project","namespace":"security-projects"},"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"region_id":{"type":"string"},"metadata":{"type":"object","properties":{"created_at":{"type":"string"},"created_by":{"type":"string"},"organization_id":{"type":"string"},"suspended_at":{"type":"string"},"suspended_reason":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1},"system_tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["created_at","created_by","organization_id"]},"cloud_id":{"type":"string"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"enum":["enabled","suspended","deleted"]},"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["status","type"]}}},"required":["projects"],"additionalProperties":false},"type":{"enum":["security"]},"endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"},"ingest":{"type":"string"}},"required":["elasticsearch","kibana","ingest"]},"private_endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"},"ingest":{"type":"string"}},"required":["elasticsearch","kibana","ingest"]},"search_lake":{"type":"object","properties":{"data_retention":{"oneOf":[{"type":"object","properties":{"max_retention_days":{"oneOf":[{"type":"number"},{"type":"null"}]},"default_retention_days":{"oneOf":[{"type":"number"},{"type":"null"}]}}},{"type":"null"}]}}},"admin_features_package":{"enum":["standard","enterprise"]},"product_types":{"type":"array","items":{"type":"object","properties":{"product_line":{"enum":["security","cloud","endpoint"]},"product_tier":{"enum":["complete","essentials"]}},"required":["product_line","product_tier"]}}},"required":["id","name","alias","region_id","metadata","cloud_id","type","endpoints"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getSecurityProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-security-project-link-candidates","name":"get-security-project-link-candidates","namespace":"linked-candidate-projects"},"x-method":"GET","x-path":"/api/v1/serverless/projects/security/{id}/link-candidates","x-destructive":false,"type":"object","properties":{"id":{"type":"string","description":"The ID of the project","x-found-in":"path"},"types":{"type":"array","description":"One or more types of projects to return as link candidates.","x-found-in":"query"},"csp":{"type":"string","description":"The Cloud Service Provider to filter the link candidate projects by.","x-found-in":"query"},"region":{"type":"string","description":"The region to filter the link candidate projects by.","x-found-in":"query"},"name":{"type":"string","description":"The project name to filter the link candidates by.","x-found-in":"query"},"alias":{"type":"string","description":"The project alias to filter the link candidates by.","x-found-in":"query"},"tags":{"type":"object","description":"If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.","x-found-in":"query"}},"required":["id"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getSecurityProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-security-project-link-candidates","name":"get-security-project-link-candidates","namespace":"linked-candidate-projects"},"x-method":"GET","x-path":"/api/v1/serverless/projects/security/{id}/link-candidates","x-destructive":false,"type":"object","properties":{"id":{"type":"string","description":"The ID of the project","x-found-in":"path"},"types":{"type":"array","items":{"enum":["elasticsearch","observability","security","vectordb"]},"description":"One or more types of projects to return as link candidates.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"csp":{"type":"string","description":"The Cloud Service Provider to filter the link candidate projects by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"region":{"type":"string","description":"The region to filter the link candidate projects by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"name":{"type":"string","description":"The project name to filter the link candidates by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"alias":{"type":"string","description":"The project alias to filter the link candidates by.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1,"description":"If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.","x-found-in":"query","x-query-serialization":{"style":"deepObject","explode":true}}},"required":["id"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getSecurityProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-security-project-link-candidates","name":"get-security-project-link-candidates","namespace":"linked-candidate-projects"},"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"type":{"enum":["elasticsearch","observability","security","vectordb"]},"csp":{"type":"string"},"region":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"linked":{"type":"boolean"}},"required":["id","name","alias","type","csp","region","tags","linked"]}}},"required":["items"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getSecurityProjectLinkCandidates","x-api":{"id":"linked-candidate-projects.get-security-project-link-candidates","name":"get-security-project-link-candidates","namespace":"linked-candidate-projects"},"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"type":{"enum":["elasticsearch","observability","security","vectordb"]},"csp":{"type":"string"},"region":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1},"linked":{"type":"boolean"}},"required":["id","name","alias","type","csp","region","tags","linked"]}}},"required":["items"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getTrafficFilterMetadata","x-api":{"id":"traffic-filters.get-traffic-filter-metadata","name":"get-traffic-filter-metadata","namespace":"traffic-filters"},"x-method":"GET","x-path":"/api/v1/serverless/traffic-filters/metadata","x-destructive":false,"type":"object","properties":{"region":{"type":"string","description":"Filter metadata to a specific region (e.g. aws-eu-west-1, azure-australiaeast).","x-found-in":"query"},"csp":{"type":"string","description":"Filter metadata to a specific cloud service provider (aws, azure, gcp).","x-found-in":"query"}}}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"getTrafficFilterMetadata","x-api":{"id":"traffic-filters.get-traffic-filter-metadata","name":"get-traffic-filter-metadata","namespace":"traffic-filters"},"x-method":"GET","x-path":"/api/v1/serverless/traffic-filters/metadata","x-destructive":false,"type":"object","properties":{"region":{"type":"string","description":"Filter metadata to a specific region (e.g. aws-eu-west-1, azure-australiaeast).","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"csp":{"type":"string","description":"Filter metadata to a specific cloud service provider (aws, azure, gcp).","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"listElasticsearchProjects","x-api":{"id":"elasticsearch-projects.list-elasticsearch-projects","name":"list-elasticsearch-projects","namespace":"elasticsearch-projects"},"x-method":"GET","x-path":"/api/v1/serverless/projects/elasticsearch","x-destructive":false,"type":"object","properties":{"traffic_filter":{"type":"string","description":"Filters the returned list of projects. Only projects associated with the provided traffic_filter will be returned.","x-found-in":"query"},"linked":{"type":"string","description":"Contains a project ID. If specified, the result will be filtered to only those origin projects that are linked to the specified project ID in a cross-project search configuration.","x-found-in":"query"},"tags":{"type":"object","description":"If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.","x-found-in":"query"}}}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"listElasticsearchProjects","x-api":{"id":"elasticsearch-projects.list-elasticsearch-projects","name":"list-elasticsearch-projects","namespace":"elasticsearch-projects"},"x-method":"GET","x-path":"/api/v1/serverless/projects/elasticsearch","x-destructive":false,"type":"object","properties":{"traffic_filter":{"type":"string","description":"Filters the returned list of projects. Only projects associated with the provided traffic_filter will be returned.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"linked":{"type":"string","description":"Contains a project ID. If specified, the result will be filtered to only those origin projects that are linked to the specified project ID in a cross-project search configuration.","x-found-in":"query","x-query-serialization":{"style":"form","explode":true}},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1,"description":"If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.","x-found-in":"query","x-query-serialization":{"style":"deepObject","explode":true}}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"listElasticsearchProjects","x-api":{"id":"elasticsearch-projects.list-elasticsearch-projects","name":"list-elasticsearch-projects","namespace":"elasticsearch-projects"},"type":"object","properties":{"next_page":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"region_id":{"type":"string"},"metadata":{"type":"object","properties":{"created_at":{"type":"string"},"created_by":{"type":"string"},"organization_id":{"type":"string"},"suspended_at":{"type":"string"},"suspended_reason":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"system_tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["created_at","created_by","organization_id"]},"cloud_id":{"type":"string"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"enum":["enabled","suspended","deleted"]},"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["status","type"]}}},"required":["projects"],"additionalProperties":false},"type":{"enum":["elasticsearch"]},"optimized_for":{"enum":["general_purpose","vector"]},"search_lake":{"type":"object","properties":{"search_power":{"type":"number"},"boost_window":{"type":"number"}}},"endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"}},"required":["elasticsearch","kibana"]},"private_endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"}},"required":["elasticsearch","kibana"]}},"required":["id","name","alias","region_id","metadata","cloud_id","type","optimized_for","endpoints"]}}},"required":["items"]}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"listElasticsearchProjects","x-api":{"id":"elasticsearch-projects.list-elasticsearch-projects","name":"list-elasticsearch-projects","namespace":"elasticsearch-projects"},"type":"object","properties":{"next_page":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"region_id":{"type":"string"},"metadata":{"type":"object","properties":{"created_at":{"type":"string"},"created_by":{"type":"string"},"organization_id":{"type":"string"},"suspended_at":{"type":"string"},"suspended_reason":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"},"maxProperties":64,"minProperties":1},"system_tags":{"type":"object","additionalProperties":{"type":"string"}}},"required":["created_at","created_by","organization_id"]},"cloud_id":{"type":"string"},"traffic_filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"linked":{"type":"object","properties":{"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"enum":["enabled","suspended","deleted"]},"type":{"enum":["elasticsearch","observability","security","vectordb"]}},"required":["status","type"]}}},"required":["projects"],"additionalProperties":false},"type":{"enum":["elasticsearch"]},"optimized_for":{"enum":["general_purpose","vector"]},"search_lake":{"type":"object","properties":{"search_power":{"type":"number"},"boost_window":{"type":"number"}}},"endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"}},"required":["elasticsearch","kibana"]},"private_endpoints":{"type":"object","properties":{"elasticsearch":{"type":"string"},"kibana":{"type":"string"}},"required":["elasticsearch","kibana"]}},"required":["id","name","alias","region_id","metadata","cloud_id","type","optimized_for","endpoints"]}}},"required":["items"]}
|