@elastic/schemas 0.4.5 → 0.5.1

package/lib/cloud/json/get_deployment_appsearch_resource_info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-appsearch-resource-info", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-appsearch-resource-info", "x-api": { "id": "deployments.get-deployment-appsearch-resource-info", "name": "get-deployment-appsearch-resource-info", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/appsearch/{ref_id}", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/get_deployment_certificate_authority.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-certificate-authority", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" } }, "required": ["deployment_id"], "$defs": { "CertificateAuthority": { "type": "object", "properties": { "recommended_trust_restriction": { "type": "string" }, "public_certificates": { "type": "array", "items": { "$ref": "#/$defs/PublicCertificate" } } }, "required": ["public_certificates", "recommended_trust_restriction"] }, "PublicCertificate": { "type": "object", "properties": { "active": { "type": "boolean" }, "pem": { "type": "string" }, "metadata": { "$ref": "_defs.json#/$defs/CertificateMetaData" } }, "required": ["active", "metadata", "pem"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-certificate-authority", "x-api": { "id": "deployments.get-deployment-certificate-authority", "name": "get-deployment-certificate-authority", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/certificate-authority", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" } }, "required": ["deployment_id"], "$defs": { "CertificateAuthority": { "type": "object", "properties": { "recommended_trust_restriction": { "type": "string" }, "public_certificates": { "type": "array", "items": { "$ref": "#/$defs/PublicCertificate" } } }, "required": ["public_certificates", "recommended_trust_restriction"] }, "PublicCertificate": { "type": "object", "properties": { "active": { "type": "boolean" }, "pem": { "type": "string" }, "metadata": { "$ref": "_defs.json#/$defs/CertificateMetaData" } }, "required": ["active", "metadata", "pem"] } } }

package/lib/cloud/json/get_deployment_enterprise_search_resource_info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-enterprise-search-resource-info", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-enterprise-search-resource-info", "x-api": { "id": "deployments.get-deployment-enterprise-search-resource-info", "name": "get-deployment-enterprise-search-resource-info", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/enterprise_search/{ref_id}", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/get_deployment_es_resource_eligible_remote_clusters.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-eligible-remote-clusters", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"], "allOf": [{ "$ref": "_defs.json#/$defs/SearchRequest" }] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-eligible-remote-clusters", "x-api": { "id": "deployments.get-deployment-es-resource-eligible-remote-clusters", "name": "get-deployment-es-resource-eligible-remote-clusters", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "from": { "type": "number", "x-found-in": "body" }, "cursor": { "type": "string", "x-found-in": "body" }, "size": { "type": "number", "x-found-in": "body" }, "query": { "$ref": "_defs.json#/$defs/QueryContainer", "x-found-in": "body" }, "sort": { "type": "array", "items": { "type": "object" }, "x-found-in": "body" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/get_deployment_es_resource_info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-info", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_security": { "type": "boolean", "description": "Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "convert_legacy_plans": { "type": "boolean", "description": "If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').", "x-found-in": "query" }, "show_system_alerts": { "type": "integer", "description": "Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "enrich_with_template": { "type": "boolean", "description": "If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-info", "x-api": { "id": "deployments.get-deployment-es-resource-info", "name": "get-deployment-es-resource-info", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_security": { "type": "boolean", "description": "Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "convert_legacy_plans": { "type": "boolean", "description": "If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').", "x-found-in": "query" }, "show_system_alerts": { "type": "integer", "description": "Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "enrich_with_template": { "type": "boolean", "description": "If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/get_deployment_es_resource_keystore.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-keystore", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-keystore", "x-api": { "id": "deployments.get-deployment-es-resource-keystore", "name": "get-deployment-es-resource-keystore", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/get_deployment_es_resource_remote_clusters.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-remote-clusters", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-remote-clusters", "x-api": { "id": "deployments.get-deployment-es-resource-remote-clusters", "name": "get-deployment-es-resource-remote-clusters", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/get_deployment_es_resource_snapshot_repository.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-snapshot-repository", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"], "$defs": { "SnapshotRepositories": { "type": "object", "properties": { "repositories": { "type": "array", "items": { "$ref": "#/$defs/SnapshotDependency" } } }, "required": ["repositories"] }, "SnapshotDependency": { "type": "object", "properties": { "cluster_id": { "type": "string" }, "deployment_id": { "type": "string" }, "deployment_name": { "type": "string" }, "repository_name": { "type": "string" } }, "required": ["cluster_id", "repository_name"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-snapshot-repository", "x-api": { "id": "deployments.get-deployment-es-resource-snapshot-repository", "name": "get-deployment-es-resource-snapshot-repository", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"], "$defs": { "SnapshotRepositories": { "type": "object", "properties": { "repositories": { "type": "array", "items": { "$ref": "#/$defs/SnapshotDependency" } } }, "required": ["repositories"] }, "SnapshotDependency": { "type": "object", "properties": { "cluster_id": { "type": "string" }, "deployment_id": { "type": "string" }, "deployment_name": { "type": "string" }, "repository_name": { "type": "string" } }, "required": ["cluster_id", "repository_name"] } } }

package/lib/cloud/json/get_deployment_es_resource_tiers.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-tiers", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"], "$defs": { "TiersResponse": { "type": "object", "properties": { "hot_content": { "$ref": "#/$defs/TierInfo" }, "warm": { "$ref": "#/$defs/TierInfo" }, "cold": { "$ref": "#/$defs/TierInfo" }, "frozen": { "$ref": "#/$defs/TierInfo" }, "master": { "$ref": "#/$defs/TierInfo" }, "coordinating": { "$ref": "#/$defs/TierInfo" }, "ml": { "$ref": "#/$defs/TierInfo" } } }, "TierInfo": { "type": "object", "properties": { "memory_size": { "type": "number" }, "zone_count": { "type": "number" }, "available_sizes": { "type": "array", "items": { "type": "number" } } } } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-es-resource-tiers", "x-api": { "id": "deployments.get-deployment-es-resource-tiers", "name": "get-deployment-es-resource-tiers", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"], "$defs": { "TiersResponse": { "type": "object", "properties": { "hot_content": { "$ref": "#/$defs/TierInfo" }, "warm": { "$ref": "#/$defs/TierInfo" }, "cold": { "$ref": "#/$defs/TierInfo" }, "frozen": { "$ref": "#/$defs/TierInfo" }, "master": { "$ref": "#/$defs/TierInfo" }, "coordinating": { "$ref": "#/$defs/TierInfo" }, "ml": { "$ref": "#/$defs/TierInfo" } } }, "TierInfo": { "type": "object", "properties": { "memory_size": { "type": "number" }, "zone_count": { "type": "number" }, "available_sizes": { "type": "array", "items": { "type": "number" } } } } } }

package/lib/cloud/json/get_deployment_integrations_server_resource_info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-integrations-server-resource-info", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-integrations-server-resource-info", "x-api": { "id": "deployments.get-deployment-integrations-server-resource-info", "name": "get-deployment-integrations-server-resource-info", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/integrations_server/{ref_id}", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/get_deployment_kib_resource_info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-kib-resource-info", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "convert_legacy_plans": { "type": "boolean", "description": "If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-kib-resource-info", "x-api": { "id": "deployments.get-deployment-kib-resource-info", "name": "get-deployment-kib-resource-info", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/kibana/{ref_id}", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "show_metadata": { "type": "boolean", "description": "Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.", "x-found-in": "query" }, "show_plans": { "type": "boolean", "description": "Whether to include the full current and pending plan information in the response - can be large per cluster.", "x-found-in": "query" }, "show_plan_logs": { "type": "boolean", "description": "Whether to include with the current and pending plan information the attempt log - can be very large per cluster.", "x-found-in": "query" }, "show_plan_history": { "type": "boolean", "description": "Whether to include with the current and pending plan information the plan history- can be very large per cluster.", "x-found-in": "query" }, "show_plan_defaults": { "type": "boolean", "description": "If showing plans, whether to show values that are left at their default value (less readable but more informative).", "x-found-in": "query" }, "convert_legacy_plans": { "type": "boolean", "description": "If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').", "x-found-in": "query" }, "show_settings": { "type": "boolean", "description": "Whether to show cluster settings in the response.", "x-found-in": "query" }, "clear_transient": { "type": "boolean", "description": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/get_deployment_resource_user_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-resource-user-settings", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" } }, "required": ["deployment_id", "resource_kind", "ref_id"], "$defs": { "DeploymentResourceUserSettingsResponse": { "type": "object", "properties": { "user_settings": { "type": "object" } } } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-resource-user-settings", "x-api": { "id": "deployments.get-deployment-resource-user-settings", "name": "get-deployment-resource-user-settings", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" } }, "required": ["deployment_id", "resource_kind", "ref_id"], "$defs": { "DeploymentResourceUserSettingsResponse": { "type": "object", "properties": { "user_settings": { "type": "object" } } } } }

package/lib/cloud/json/get_deployment_tags.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-tags", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" } }, "required": ["deployment_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-tags", "x-api": { "id": "deployments.get-deployment-tags", "name": "get-deployment-tags", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/tags", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" } }, "required": ["deployment_id"] }

package/lib/cloud/json/get_deployment_template_v2.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-template-v2", "type": "object", "properties": { "template_id": { "type": "string", "description": "The identifier for the deployment template.", "x-found-in": "path" }, "show_instance_configurations": { "type": "boolean", "description": "If true, will return details for each instance configuration referenced by the template.", "x-found-in": "query" }, "show_max_zones": { "type": "boolean", "description": "If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.", "x-found-in": "query" }, "stack_version": { "type": "string", "description": "If present, it will cause the returned deployment template to be adapted to return only the elements allowed in that version.", "x-found-in": "query" }, "region": { "type": "string", "description": "Region of the deployment template", "x-found-in": "query" } }, "required": ["template_id", "region"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-template-v2", "x-api": { "id": "deployment-templates.get-deployment-template-v2", "name": "get-deployment-template-v2", "namespace": "deployment-templates" }, "x-method": "GET", "x-path": "/api/v1/deployments/templates/{template_id}", "x-destructive": false, "type": "object", "properties": { "template_id": { "type": "string", "description": "The identifier for the deployment template.", "x-found-in": "path" }, "show_instance_configurations": { "type": "boolean", "description": "If true, will return details for each instance configuration referenced by the template.", "x-found-in": "query" }, "show_max_zones": { "type": "boolean", "description": "If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.", "x-found-in": "query" }, "stack_version": { "type": "string", "description": "If present, it will cause the returned deployment template to be adapted to return only the elements allowed in that version.", "x-found-in": "query" }, "region": { "type": "string", "description": "Region of the deployment template", "x-found-in": "query" } }, "required": ["template_id", "region"] }

package/lib/cloud/json/get_deployment_templates_v2.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-templates-v2", "type": "object", "properties": { "metadata": { "type": "string", "description": "An optional key/value pair in the form of (key:value) that will act as a filter and exclude any templates that do not have a matching metadata item associated.", "x-found-in": "query" }, "show_instance_configurations": { "type": "boolean", "description": "If true, will return details for each instance configuration referenced by the template.", "x-found-in": "query" }, "show_max_zones": { "type": "boolean", "description": "If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.", "x-found-in": "query" }, "stack_version": { "type": "string", "description": "If present, it will cause the returned deployment templates to be adapted to return only the elements allowed in that version.", "x-found-in": "query" }, "hide_deprecated": { "type": "boolean", "description": "If true, templates flagged as deprecated will NOT be returned.", "x-found-in": "query" }, "region": { "type": "string", "description": "Region of the deployment templates", "x-found-in": "query" } }, "required": ["region"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-templates-v2", "x-api": { "id": "deployment-templates.get-deployment-templates-v2", "name": "get-deployment-templates-v2", "namespace": "deployment-templates" }, "x-method": "GET", "x-path": "/api/v1/deployments/templates", "x-destructive": false, "type": "object", "properties": { "metadata": { "type": "string", "description": "An optional key/value pair in the form of (key:value) that will act as a filter and exclude any templates that do not have a matching metadata item associated.", "x-found-in": "query" }, "show_instance_configurations": { "type": "boolean", "description": "If true, will return details for each instance configuration referenced by the template.", "x-found-in": "query" }, "show_max_zones": { "type": "boolean", "description": "If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.", "x-found-in": "query" }, "stack_version": { "type": "string", "description": "If present, it will cause the returned deployment templates to be adapted to return only the elements allowed in that version.", "x-found-in": "query" }, "hide_deprecated": { "type": "boolean", "description": "If true, templates flagged as deprecated will NOT be returned.", "x-found-in": "query" }, "region": { "type": "string", "description": "Region of the deployment templates", "x-found-in": "query" } }, "required": ["region"] }

package/lib/cloud/json/get_deployment_upgrade_assistant_status.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-upgrade-assistant-status", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "target_version": { "type": "string", "description": "If present, value is included in resource request to provide additional context (only supported for Kibana)", "x-found-in": "query" } }, "required": ["deployment_id"], "$defs": { "DeploymentUpgradeAssistantStatusResponse": { "type": "object", "properties": { "ready_for_upgrade": { "type": "boolean" }, "details": { "type": "string" } }, "required": ["details", "ready_for_upgrade"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-deployment-upgrade-assistant-status", "x-api": { "id": "deployments.get-deployment-upgrade-assistant-status", "name": "get-deployment-upgrade-assistant-status", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/upgrade_assistant/status", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "target_version": { "type": "string", "description": "If present, value is included in resource request to provide additional context (only supported for Kibana)", "x-found-in": "query" } }, "required": ["deployment_id"], "$defs": { "DeploymentUpgradeAssistantStatusResponse": { "type": "object", "properties": { "ready_for_upgrade": { "type": "boolean" }, "details": { "type": "string" } }, "required": ["details", "ready_for_upgrade"] } } }

package/lib/cloud/json/get_extension.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-extension", "type": "object", "properties": { "extension_id": { "type": "string", "description": "Id of an extension", "x-found-in": "path" }, "include_deployments": { "type": "boolean", "description": "Include deployments referencing this extension. Up to only 10000 deployments will be included.", "x-found-in": "query" } }, "required": ["extension_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-extension", "x-api": { "id": "extensions.get-extension", "name": "get-extension", "namespace": "extensions" }, "x-method": "GET", "x-path": "/api/v1/deployments/extensions/{extension_id}", "x-destructive": false, "type": "object", "properties": { "extension_id": { "type": "string", "description": "Id of an extension", "x-found-in": "path" }, "include_deployments": { "type": "boolean", "description": "Include deployments referencing this extension. Up to only 10000 deployments will be included.", "x-found-in": "query" } }, "required": ["extension_id"] }

package/lib/cloud/json/get_organization.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-organization", "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-organization", "x-api": { "id": "organizations.get-organization", "name": "get-organization", "namespace": "organizations" }, "x-method": "GET", "x-path": "/api/v1/organizations/{organization_id}", "x-destructive": false, "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"] }

package/lib/cloud/json/get_organization_idp.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-organization-idp", "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-organization-idp", "x-api": { "id": "organizations.get-organization-idp", "name": "get-organization-idp", "namespace": "organizations" }, "x-method": "GET", "x-path": "/api/v1/organizations/{organization_id}/idp", "x-destructive": false, "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"] }

package/lib/cloud/json/get_organization_idp_metadata.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-organization-idp-metadata", "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-organization-idp-metadata", "x-api": { "id": "organizations.get-organization-idp-metadata", "name": "get-organization-idp-metadata", "namespace": "organizations" }, "x-method": "GET", "x-path": "/api/v1/organizations/{organization_id}/idp/metadata.xml", "x-destructive": false, "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"] }

package/lib/cloud/json/get_organization_invitation.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-organization-invitation", "type": "object", "properties": { "invitation_token": { "type": "string", "description": "Organization invitation token", "x-found-in": "path" } }, "required": ["invitation_token"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-organization-invitation", "x-api": { "id": "organizations.get-organization-invitation", "name": "get-organization-invitation", "namespace": "organizations" }, "x-method": "GET", "x-path": "/api/v1/organizations/invitations/{invitation_token}", "x-destructive": false, "type": "object", "properties": { "invitation_token": { "type": "string", "description": "Organization invitation token", "x-found-in": "path" } }, "required": ["invitation_token"] }

package/lib/cloud/json/get_role_mappings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-role-mappings", "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"], "$defs": { "GetRoleMappingsResponse": { "type": "object", "properties": { "mappings": { "type": "array", "items": { "$ref": "_defs.json#/$defs/RoleMapping" } } }, "required": ["mappings"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-role-mappings", "x-api": { "id": "organizations.get-role-mappings", "name": "get-role-mappings", "namespace": "organizations" }, "x-method": "GET", "x-path": "/api/v1/organizations/{organization_id}/role_mappings", "x-destructive": false, "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"], "$defs": { "GetRoleMappingsResponse": { "type": "object", "properties": { "mappings": { "type": "array", "items": { "$ref": "_defs.json#/$defs/RoleMapping" } } }, "required": ["mappings"] } } }

package/lib/cloud/json/get_traffic_filter_claimed_link_ids.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-claimed-link-ids", "type": "object", "properties": { "region": { "type": "string", "description": "If provided limits the claimed id to that region only.", "x-found-in": "query" }, "organization_id": { "type": "string", "description": "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.", "x-found-in": "query" } }, "$defs": { "TrafficFilterClaimedLinkIds": { "type": "object", "properties": { "claimed_link_ids": { "type": "array", "items": { "$ref": "#/$defs/TrafficFilterClaimedLinkIdInfo" } } }, "required": ["claimed_link_ids"] }, "TrafficFilterClaimedLinkIdInfo": { "type": "object", "properties": { "link_id": { "type": "string" }, "azure_endpoint_name": { "type": "string" }, "azure_endpoint_guid": { "type": "string" }, "region": { "type": "string" } }, "required": ["region"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-claimed-link-ids", "x-api": { "id": "deployments-traffic-filter.get-traffic-filter-claimed-link-ids", "name": "get-traffic-filter-claimed-link-ids", "namespace": "deployments-traffic-filter" }, "x-method": "GET", "x-path": "/api/v1/deployments/traffic-filter/link-ids", "x-destructive": false, "type": "object", "properties": { "region": { "type": "string", "description": "If provided limits the claimed id to that region only.", "x-found-in": "query" }, "organization_id": { "type": "string", "description": "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.", "x-found-in": "query" } }, "$defs": { "TrafficFilterClaimedLinkIds": { "type": "object", "properties": { "claimed_link_ids": { "type": "array", "items": { "$ref": "#/$defs/TrafficFilterClaimedLinkIdInfo" } } }, "required": ["claimed_link_ids"] }, "TrafficFilterClaimedLinkIdInfo": { "type": "object", "properties": { "link_id": { "type": "string" }, "azure_endpoint_name": { "type": "string" }, "azure_endpoint_guid": { "type": "string" }, "region": { "type": "string" } }, "required": ["region"] } } }

package/lib/cloud/json/get_traffic_filter_deployment_ruleset_associations.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-deployment-ruleset-associations", "type": "object", "properties": { "association_type": { "type": "string", "description": "Association type", "x-found-in": "path" }, "associated_entity_id": { "type": "string", "description": "Associated entity ID", "x-found-in": "path" } }, "required": ["association_type", "associated_entity_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-deployment-ruleset-associations", "x-api": { "id": "deployments-traffic-filter.get-traffic-filter-deployment-ruleset-associations", "name": "get-traffic-filter-deployment-ruleset-associations", "namespace": "deployments-traffic-filter" }, "x-method": "GET", "x-path": "/api/v1/deployments/traffic-filter/associations/{association_type}/{associated_entity_id}/rulesets", "x-destructive": false, "type": "object", "properties": { "association_type": { "type": "string", "description": "Association type", "x-found-in": "path" }, "associated_entity_id": { "type": "string", "description": "Associated entity ID", "x-found-in": "path" } }, "required": ["association_type", "associated_entity_id"] }

package/lib/cloud/json/get_traffic_filter_ruleset.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-ruleset", "type": "object", "properties": { "ruleset_id": { "type": "string", "description": "The mandatory ruleset ID.", "x-found-in": "path" }, "include_associations": { "type": "boolean", "description": "Retrieves a list of resources that are associated to the specified ruleset.", "x-found-in": "query" } }, "required": ["ruleset_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-ruleset", "x-api": { "id": "deployments-traffic-filter.get-traffic-filter-ruleset", "name": "get-traffic-filter-ruleset", "namespace": "deployments-traffic-filter" }, "x-method": "GET", "x-path": "/api/v1/deployments/traffic-filter/rulesets/{ruleset_id}", "x-destructive": false, "type": "object", "properties": { "ruleset_id": { "type": "string", "description": "The mandatory ruleset ID.", "x-found-in": "path" }, "include_associations": { "type": "boolean", "description": "Retrieves a list of resources that are associated to the specified ruleset.", "x-found-in": "query" } }, "required": ["ruleset_id"] }

package/lib/cloud/json/get_traffic_filter_ruleset_deployment_associations.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-ruleset-deployment-associations", "type": "object", "properties": { "ruleset_id": { "type": "string", "description": "The mandatory ruleset ID.", "x-found-in": "path" } }, "required": ["ruleset_id"], "$defs": { "RulesetAssociations": { "type": "object", "properties": { "associations": { "type": "array", "items": { "$ref": "_defs.json#/$defs/FilterAssociation" } }, "total_associations": { "type": "number" } }, "required": ["associations", "total_associations"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-ruleset-deployment-associations", "x-api": { "id": "deployments-traffic-filter.get-traffic-filter-ruleset-deployment-associations", "name": "get-traffic-filter-ruleset-deployment-associations", "namespace": "deployments-traffic-filter" }, "x-method": "GET", "x-path": "/api/v1/deployments/traffic-filter/rulesets/{ruleset_id}/associations", "x-destructive": false, "type": "object", "properties": { "ruleset_id": { "type": "string", "description": "The mandatory ruleset ID.", "x-found-in": "path" } }, "required": ["ruleset_id"], "$defs": { "RulesetAssociations": { "type": "object", "properties": { "associations": { "type": "array", "items": { "$ref": "_defs.json#/$defs/FilterAssociation" } }, "total_associations": { "type": "number" } }, "required": ["associations", "total_associations"] } } }

package/lib/cloud/json/get_traffic_filter_rulesets.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-rulesets", "type": "object", "properties": { "include_associations": { "type": "boolean", "description": "Retrieves a list of resources that are associated to the specified ruleset.", "x-found-in": "query" }, "region": { "type": "string", "description": "If provided limits the rulesets to that region only.", "x-found-in": "query" }, "organization_id": { "type": "string", "description": "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.", "x-found-in": "query" } }, "$defs": { "TrafficFilterRulesets": { "type": "object", "properties": { "rulesets": { "type": "array", "items": { "$ref": "_defs.json#/$defs/TrafficFilterRulesetInfo" } } }, "required": ["rulesets"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-traffic-filter-rulesets", "x-api": { "id": "deployments-traffic-filter.get-traffic-filter-rulesets", "name": "get-traffic-filter-rulesets", "namespace": "deployments-traffic-filter" }, "x-method": "GET", "x-path": "/api/v1/deployments/traffic-filter/rulesets", "x-destructive": false, "type": "object", "properties": { "include_associations": { "type": "boolean", "description": "Retrieves a list of resources that are associated to the specified ruleset.", "x-found-in": "query" }, "region": { "type": "string", "description": "If provided limits the rulesets to that region only.", "x-found-in": "query" }, "organization_id": { "type": "string", "description": "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.", "x-found-in": "query" } }, "$defs": { "TrafficFilterRulesets": { "type": "object", "properties": { "rulesets": { "type": "array", "items": { "$ref": "_defs.json#/$defs/TrafficFilterRulesetInfo" } } }, "required": ["rulesets"] } } }

package/lib/cloud/json/get_version_stacks.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-version-stacks", "type": "object", "properties": { "show_deleted": { "type": "boolean", "description": "Whether to show deleted stack versions or not", "x-found-in": "query" }, "show_unusable": { "type": "boolean", "description": "Whether to show versions that are unusable by the authenticated user", "x-found-in": "query" } }, "$defs": { "StackVersionConfigs": { "type": "object", "properties": { "stacks": { "type": "array", "items": { "$ref": "#/$defs/StackVersionConfig" } } }, "required": ["stacks"] }, "StackVersionConfig": { "type": "object", "properties": { "version": { "type": "string" }, "template": { "$ref": "#/$defs/StackVersionTemplateInfo" }, "elasticsearch": { "$ref": "#/$defs/StackVersionElasticsearchConfig" }, "kibana": { "$ref": "#/$defs/StackVersionKibanaConfig" }, "apm": { "$ref": "#/$defs/StackVersionApmConfig" }, "appsearch": { "$ref": "#/$defs/StackVersionAppSearchConfig" }, "metadata": { "$ref": "#/$defs/StackVersionMetadata" }, "deleted": { "type": "boolean" }, "upgradable_to": { "type": "array", "items": { "type": "string" } }, "min_upgradable_from": { "type": "string" }, "whitelisted": { "type": "boolean" }, "accessible": { "type": "boolean" }, "rolling_upgrade_compatible_versions": { "type": "array", "items": { "type": "string" } } }, "required": ["elasticsearch", "kibana", "template", "upgradable_to"] }, "StackVersionMetadata": { "type": "object", "properties": { "notes": { "type": "string" }, "pre_release": { "type": "boolean" }, "min_platform_version": { "type": "string" }, "min_wire_compatibility_version": { "type": "string" }, "min_index_compatibility_version": { "type": "string" }, "schema_version": { "type": "number" }, "is_fips": { "type": "boolean" } } }, "StackVersionAppSearchConfig": { "type": "object", "properties": { "version": { "type": "string" }, "docker_image": { "type": "string" }, "blacklist": { "type": "array", "items": { "type": "string" } }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } }, "node_types": { "type": "array", "items": { "$ref": "#/$defs/StackVersionNodeType" } } }, "required": ["blacklist", "docker_image"] }, "StackVersionNodeType": { "type": "object", "properties": { "node_type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } }, "mandatory": { "type": "boolean" } }, "required": ["description", "name", "node_type"] }, "StackVersionInstanceCapacityConstraint": { "type": "object", "properties": { "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["max", "min"] }, "StackVersionApmConfig": { "type": "object", "properties": { "version": { "type": "string" }, "docker_image": { "type": "string" }, "blacklist": { "type": "array", "items": { "type": "string" } }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } } }, "required": ["blacklist", "docker_image"] }, "StackVersionKibanaConfig": { "type": "object", "properties": { "version": { "type": "string" }, "docker_image": { "type": "string" }, "blacklist": { "type": "array", "items": { "type": "string" } }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } } }, "required": ["blacklist", "docker_image"] }, "StackVersionElasticsearchConfig": { "type": "object", "properties": { "docker_image": { "type": "string" }, "plugins": { "type": "array", "items": { "type": "string" } }, "default_plugins": { "type": "array", "items": { "type": "string" } }, "blacklist": { "type": "array", "items": { "type": "string" } }, "node_types": { "type": "array", "items": { "$ref": "#/$defs/StackVersionNodeType" } }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } } }, "required": ["blacklist", "default_plugins", "docker_image", "plugins"] }, "StackVersionTemplateInfo": { "type": "object", "properties": { "template_version": { "type": "string" }, "hashes": { "type": "array", "items": { "$ref": "#/$defs/StackVersionTemplateFileHash" } } } }, "StackVersionTemplateFileHash": { "type": "object", "properties": { "path": { "type": "string" }, "hash": { "type": "string" } }, "required": ["hash", "path"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get-version-stacks", "x-api": { "id": "stack.get-version-stacks", "name": "get-version-stacks", "namespace": "stack" }, "x-method": "GET", "x-path": "/api/v1/stack/versions", "x-destructive": false, "type": "object", "properties": { "show_deleted": { "type": "boolean", "description": "Whether to show deleted stack versions or not", "x-found-in": "query" }, "show_unusable": { "type": "boolean", "description": "Whether to show versions that are unusable by the authenticated user", "x-found-in": "query" } }, "$defs": { "StackVersionConfigs": { "type": "object", "properties": { "stacks": { "type": "array", "items": { "$ref": "#/$defs/StackVersionConfig" } } }, "required": ["stacks"] }, "StackVersionConfig": { "type": "object", "properties": { "version": { "type": "string" }, "template": { "$ref": "#/$defs/StackVersionTemplateInfo" }, "elasticsearch": { "$ref": "#/$defs/StackVersionElasticsearchConfig" }, "kibana": { "$ref": "#/$defs/StackVersionKibanaConfig" }, "apm": { "$ref": "#/$defs/StackVersionApmConfig" }, "appsearch": { "$ref": "#/$defs/StackVersionAppSearchConfig" }, "metadata": { "$ref": "#/$defs/StackVersionMetadata" }, "deleted": { "type": "boolean" }, "upgradable_to": { "type": "array", "items": { "type": "string" } }, "min_upgradable_from": { "type": "string" }, "whitelisted": { "type": "boolean" }, "accessible": { "type": "boolean" }, "rolling_upgrade_compatible_versions": { "type": "array", "items": { "type": "string" } } }, "required": ["elasticsearch", "kibana", "template", "upgradable_to"] }, "StackVersionMetadata": { "type": "object", "properties": { "notes": { "type": "string" }, "pre_release": { "type": "boolean" }, "min_platform_version": { "type": "string" }, "min_wire_compatibility_version": { "type": "string" }, "min_index_compatibility_version": { "type": "string" }, "schema_version": { "type": "number" }, "is_fips": { "type": "boolean" } } }, "StackVersionAppSearchConfig": { "type": "object", "properties": { "version": { "type": "string" }, "docker_image": { "type": "string" }, "blacklist": { "type": "array", "items": { "type": "string" } }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } }, "node_types": { "type": "array", "items": { "$ref": "#/$defs/StackVersionNodeType" } } }, "required": ["blacklist", "docker_image"] }, "StackVersionNodeType": { "type": "object", "properties": { "node_type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } }, "mandatory": { "type": "boolean" } }, "required": ["description", "name", "node_type"] }, "StackVersionInstanceCapacityConstraint": { "type": "object", "properties": { "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["max", "min"] }, "StackVersionApmConfig": { "type": "object", "properties": { "version": { "type": "string" }, "docker_image": { "type": "string" }, "blacklist": { "type": "array", "items": { "type": "string" } }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } } }, "required": ["blacklist", "docker_image"] }, "StackVersionKibanaConfig": { "type": "object", "properties": { "version": { "type": "string" }, "docker_image": { "type": "string" }, "blacklist": { "type": "array", "items": { "type": "string" } }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } } }, "required": ["blacklist", "docker_image"] }, "StackVersionElasticsearchConfig": { "type": "object", "properties": { "docker_image": { "type": "string" }, "plugins": { "type": "array", "items": { "type": "string" } }, "default_plugins": { "type": "array", "items": { "type": "string" } }, "blacklist": { "type": "array", "items": { "type": "string" } }, "node_types": { "type": "array", "items": { "$ref": "#/$defs/StackVersionNodeType" } }, "settings": { "type": "object" }, "capacity_constraints": { "$ref": "#/$defs/StackVersionInstanceCapacityConstraint" }, "compatible_node_types": { "type": "array", "items": { "type": "string" } } }, "required": ["blacklist", "default_plugins", "docker_image", "plugins"] }, "StackVersionTemplateInfo": { "type": "object", "properties": { "template_version": { "type": "string" }, "hashes": { "type": "array", "items": { "$ref": "#/$defs/StackVersionTemplateFileHash" } } } }, "StackVersionTemplateFileHash": { "type": "object", "properties": { "path": { "type": "string" }, "hash": { "type": "string" } }, "required": ["hash", "path"] } } }

package/lib/cloud/json/list_organization_invitations.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "list-organization-invitations", "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"], "$defs": { "OrganizationInvitations": { "type": "object", "properties": { "invitations": { "type": "array", "items": { "$ref": "_defs.json#/$defs/OrganizationInvitation" } } }, "required": ["invitations"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "list-organization-invitations", "x-api": { "id": "organizations.list-organization-invitations", "name": "list-organization-invitations", "namespace": "organizations" }, "x-method": "GET", "x-path": "/api/v1/organizations/{organization_id}/invitations", "x-destructive": false, "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"], "$defs": { "OrganizationInvitations": { "type": "object", "properties": { "invitations": { "type": "array", "items": { "$ref": "_defs.json#/$defs/OrganizationInvitation" } } }, "required": ["invitations"] } } }

package/lib/cloud/json/list_organization_members.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "list-organization-members", "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"], "$defs": { "OrganizationMemberships": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/$defs/OrganizationMembership" } } }, "required": ["members"] }, "OrganizationMembership": { "type": "object", "properties": { "organization_id": { "type": "string" }, "user_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "member_since": { "type": "string" }, "role_assignments": { "$ref": "_defs.json#/$defs/RoleAssignments" } }, "required": ["member_since", "organization_id", "user_id"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "list-organization-members", "x-api": { "id": "organizations.list-organization-members", "name": "list-organization-members", "namespace": "organizations" }, "x-method": "GET", "x-path": "/api/v1/organizations/{organization_id}/members", "x-destructive": false, "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"], "$defs": { "OrganizationMemberships": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/$defs/OrganizationMembership" } } }, "required": ["members"] }, "OrganizationMembership": { "type": "object", "properties": { "organization_id": { "type": "string" }, "user_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "member_since": { "type": "string" }, "role_assignments": { "$ref": "_defs.json#/$defs/RoleAssignments" } }, "required": ["member_since", "organization_id", "user_id"] } } }

package/lib/cloud/json/migrate_deployment_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "migrate-deployment-template", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "template_id": { "type": "string", "description": "The ID of the deployment template to migrate to", "x-found-in": "query" }, "skip_instance_metrics_check": { "type": "boolean", "description": "If true, will skip the instance metrics check for memory and disk usage calculations", "x-found-in": "query" } }, "required": ["deployment_id", "template_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "migrate-deployment-template", "x-api": { "id": "deployments.migrate-deployment-template", "name": "migrate-deployment-template", "namespace": "deployments" }, "x-method": "GET", "x-path": "/api/v1/deployments/{deployment_id}/migrate_template", "x-destructive": false, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "template_id": { "type": "string", "description": "The ID of the deployment template to migrate to", "x-found-in": "query" }, "skip_instance_metrics_check": { "type": "boolean", "description": "If true, will skip the instance metrics check for memory and disk usage calculations", "x-found-in": "query" } }, "required": ["deployment_id", "template_id"] }

package/lib/cloud/json/patch_current_account.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "patch-current-account", "type": "string" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "patch-current-account", "x-api": { "id": "accounts.patch-current-account", "name": "patch-current-account", "namespace": "accounts" }, "x-method": "PATCH", "x-path": "/api/v1/account", "x-destructive": true, "type": "object", "properties": { "body": { "type": "string", "x-found-in": "body", "x-body-root": true } } }

package/lib/cloud/json/remove_role_assignments.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "remove-role-assignments", "type": "object", "properties": { "user_id": { "type": "string", "description": "Identifier for the user; include realm name and id if required", "x-found-in": "path" } }, "required": ["user_id"], "allOf": [{ "$ref": "_defs.json#/$defs/RoleAssignments" }] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "remove-role-assignments", "x-api": { "id": "user-role-assignments.remove-role-assignments", "name": "remove-role-assignments", "namespace": "user-role-assignments" }, "x-method": "DELETE", "x-path": "/api/v1/users/{user_id}/role_assignments", "x-destructive": true, "type": "object", "properties": { "user_id": { "type": "string", "description": "Identifier for the user; include realm name and id if required", "x-found-in": "path" }, "platform": { "type": "array", "items": { "$ref": "_defs.json#/$defs/PlatformRoleAssignment" }, "x-found-in": "body" }, "organization": { "type": "array", "items": { "$ref": "_defs.json#/$defs/OrganizationRoleAssignment" }, "x-found-in": "body" }, "deployment": { "type": "array", "items": { "$ref": "_defs.json#/$defs/DeploymentRoleAssignment" }, "x-found-in": "body" }, "project": { "$ref": "_defs.json#/$defs/ProjectRoleAssignments", "x-found-in": "body" } }, "required": ["user_id"] }

package/lib/cloud/json/reset_elasticsearch_user_password.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "reset-elasticsearch-user-password", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "check_completion": { "type": "boolean", "description": "If true, will not reset elastic user password and instead will return a status code signaling whether or not the current credentials are ready to use (eg from creation or the last call to _reset_password)", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"], "$defs": { "ElasticsearchElasticUserPasswordResetResponse": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": ["password", "username"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "reset-elasticsearch-user-password", "x-api": { "id": "deployments.reset-elasticsearch-user-password", "name": "reset-elasticsearch-user-password", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "check_completion": { "type": "boolean", "description": "If true, will not reset elastic user password and instead will return a status code signaling whether or not the current credentials are ready to use (eg from creation or the last call to _reset_password)", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"], "$defs": { "ElasticsearchElasticUserPasswordResetResponse": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": ["password", "username"] } } }

package/lib/cloud/json/restart_deployment_es_resource.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "restart-deployment-es-resource", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "restore_snapshot": { "type": "boolean", "description": "When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).", "x-found-in": "query" }, "skip_snapshot": { "type": "boolean", "description": "If true, will not take a snapshot of the cluster before restarting.", "x-found-in": "query" }, "cancel_pending": { "type": "boolean", "description": "If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.", "x-found-in": "query" }, "group_attribute": { "type": "string", "description": "Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: '\\_\\_all\\_\\_' (restart all at once), '\\_\\_zone\\_\\_' by logical zone, '\\_\\_name\\_\\_' one instance at a time, or a comma-separated list of attributes of the instances", "x-found-in": "query" }, "shard_init_wait_time": { "type": "integer", "description": "The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "restart-deployment-es-resource", "x-api": { "id": "deployments.restart-deployment-es-resource", "name": "restart-deployment-es-resource", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "restore_snapshot": { "type": "boolean", "description": "When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).", "x-found-in": "query" }, "skip_snapshot": { "type": "boolean", "description": "If true, will not take a snapshot of the cluster before restarting.", "x-found-in": "query" }, "cancel_pending": { "type": "boolean", "description": "If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.", "x-found-in": "query" }, "group_attribute": { "type": "string", "description": "Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: '\\_\\_all\\_\\_' (restart all at once), '\\_\\_zone\\_\\_' by logical zone, '\\_\\_name\\_\\_' one instance at a time, or a comma-separated list of attributes of the instances", "x-found-in": "query" }, "shard_init_wait_time": { "type": "integer", "description": "The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/restart_deployment_stateless_resource.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "restart-deployment-stateless-resource", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "stateless_resource_kind": { "type": "string", "description": "The kind of stateless resource", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "cancel_pending": { "type": "boolean", "description": "If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.", "x-found-in": "query" } }, "required": ["deployment_id", "stateless_resource_kind", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "restart-deployment-stateless-resource", "x-api": { "id": "deployments.restart-deployment-stateless-resource", "name": "restart-deployment-stateless-resource", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "stateless_resource_kind": { "type": "string", "description": "The kind of stateless resource", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "cancel_pending": { "type": "boolean", "description": "If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.", "x-found-in": "query" } }, "required": ["deployment_id", "stateless_resource_kind", "ref_id"] }

package/lib/cloud/json/restore_deployment.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "restore-deployment", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "restore_snapshot": { "type": "boolean", "description": "Whether or not to restore a snapshot for those resources that allow it.", "x-found-in": "query" } }, "required": ["deployment_id"], "$defs": { "DeploymentRestoreResponse": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "restore-deployment", "x-api": { "id": "deployments.restore-deployment", "name": "restore-deployment", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/_restore", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "restore_snapshot": { "type": "boolean", "description": "Whether or not to restore a snapshot for those resources that allow it.", "x-found-in": "query" } }, "required": ["deployment_id"], "$defs": { "DeploymentRestoreResponse": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] } } }

package/lib/cloud/json/restore_deployment_resource.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "restore-deployment-resource", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" }, "restore_snapshot": { "type": "boolean", "description": "Whether or not to restore a snapshot for those resources that allow it.", "x-found-in": "query" } }, "required": ["deployment_id", "resource_kind", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "restore-deployment-resource", "x-api": { "id": "deployments.restore-deployment-resource", "name": "restore-deployment-resource", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" }, "restore_snapshot": { "type": "boolean", "description": "Whether or not to restore a snapshot for those resources that allow it.", "x-found-in": "query" } }, "required": ["deployment_id", "resource_kind", "ref_id"] }

package/lib/cloud/json/search_deployments.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search-deployments", "type": "object", "properties": { "minimal_metadata": { "type": "string", "description": "Comma separated list of attributes to include in response for deployments found. Useful for reducing response size when retrieving many deployments. Use of this parameter moves the result to the minimal_metadata section of the response.", "x-found-in": "query" } }, "allOf": [{ "$ref": "_defs.json#/$defs/SearchRequest" }] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search-deployments", "x-api": { "id": "deployments.search-deployments", "name": "search-deployments", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/_search", "x-destructive": true, "type": "object", "properties": { "minimal_metadata": { "type": "string", "description": "Comma separated list of attributes to include in response for deployments found. Useful for reducing response size when retrieving many deployments. Use of this parameter moves the result to the minimal_metadata section of the response.", "x-found-in": "query" }, "from": { "type": "number", "x-found-in": "body" }, "cursor": { "type": "string", "x-found-in": "body" }, "size": { "type": "number", "x-found-in": "body" }, "query": { "$ref": "_defs.json#/$defs/QueryContainer", "x-found-in": "body" }, "sort": { "type": "array", "items": { "type": "object" }, "x-found-in": "body" } } }

package/lib/cloud/json/search_eligible_remote_clusters.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search-eligible-remote-clusters", "type": "object", "properties": { "version": { "type": "string", "description": "The version of the Elasticsearch cluster cluster that will potentially be configured to have remote clusters.", "x-found-in": "query" } }, "required": ["version"], "allOf": [{ "$ref": "_defs.json#/$defs/SearchRequest" }] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search-eligible-remote-clusters", "x-api": { "id": "deployments.search-eligible-remote-clusters", "name": "search-eligible-remote-clusters", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/eligible-remote-clusters", "x-destructive": true, "type": "object", "properties": { "version": { "type": "string", "description": "The version of the Elasticsearch cluster cluster that will potentially be configured to have remote clusters.", "x-found-in": "query" }, "from": { "type": "number", "x-found-in": "body" }, "cursor": { "type": "string", "x-found-in": "body" }, "size": { "type": "number", "x-found-in": "body" }, "query": { "$ref": "_defs.json#/$defs/QueryContainer", "x-found-in": "body" }, "sort": { "type": "array", "items": { "type": "object" }, "x-found-in": "body" } }, "required": ["version"] }

package/lib/cloud/json/set_appsearch_read_only_mode.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-appsearch-read-only-mode", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"], "allOf": [{ "$ref": "#/$defs/ReadOnlyRequest" }], "$defs": { "ReadOnlyRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-appsearch-read-only-mode", "x-api": { "id": "deployments.set-appsearch-read-only-mode", "name": "set-appsearch-read-only-mode", "namespace": "deployments" }, "x-method": "PUT", "x-path": "/api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "enabled": { "type": "boolean", "x-found-in": "body" } }, "required": ["deployment_id", "ref_id", "enabled"], "$defs": { "ReadOnlyRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"] } } }

package/lib/cloud/json/set_deployment_es_resource_keystore.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-deployment-es-resource-keystore", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" }, "validate_only": { "type": "boolean", "description": "When `true`, does nothing except return the entries' allowlist and reloadability statuses.", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"], "allOf": [{ "$ref": "_defs.json#/$defs/KeystoreContents" }] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-deployment-es-resource-keystore", "x-api": { "id": "deployments.set-deployment-es-resource-keystore", "name": "set-deployment-es-resource-keystore", "namespace": "deployments" }, "x-method": "PATCH", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one)", "x-found-in": "path" }, "validate_only": { "type": "boolean", "description": "When `true`, does nothing except return the entries' allowlist and reloadability statuses.", "x-found-in": "query" }, "secrets": { "type": "object", "additionalProperties": { "$ref": "_defs.json#/$defs/KeystoreSecret" }, "x-found-in": "body" } }, "required": ["deployment_id", "ref_id", "secrets"] }

package/lib/cloud/json/set_deployment_es_resource_remote_clusters.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-deployment-es-resource-remote-clusters", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "ref_id"], "allOf": [{ "$ref": "_defs.json#/$defs/RemoteResources" }] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-deployment-es-resource-remote-clusters", "x-api": { "id": "deployments.set-deployment-es-resource-remote-clusters", "name": "set-deployment-es-resource-remote-clusters", "namespace": "deployments" }, "x-method": "PUT", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "resources": { "type": "array", "items": { "$ref": "_defs.json#/$defs/RemoteResourceRef" }, "x-found-in": "body" } }, "required": ["deployment_id", "ref_id", "resources"] }

package/lib/cloud/json/set_deployment_tags.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-deployment-tags", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" } }, "required": ["deployment_id"], "allOf": [{ "$ref": "_defs.json#/$defs/DeploymentTagsResponse" }] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "set-deployment-tags", "x-api": { "id": "deployments.set-deployment-tags", "name": "set-deployment-tags", "namespace": "deployments" }, "x-method": "PUT", "x-path": "/api/v1/deployments/{deployment_id}/tags", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "tags": { "type": "array", "items": { "$ref": "_defs.json#/$defs/MetadataItem" }, "x-found-in": "body" } }, "required": ["deployment_id"] }

package/lib/cloud/json/setup_organization_idp.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "setup-organization-idp", "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" } }, "required": ["organization_id"], "allOf": [{ "$ref": "#/$defs/IdpConfigurationRequest" }], "$defs": { "IdpConfigurationRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "login_identifier_prefix": { "type": "string" }, "saml_idp": { "$ref": "_defs.json#/$defs/SamlIdp" } }, "required": ["enabled", "login_identifier_prefix", "saml_idp"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "setup-organization-idp", "x-api": { "id": "organizations.setup-organization-idp", "name": "setup-organization-idp", "namespace": "organizations" }, "x-method": "PUT", "x-path": "/api/v1/organizations/{organization_id}/idp", "x-destructive": true, "type": "object", "properties": { "organization_id": { "type": "string", "description": "Identifier for the Organization", "x-found-in": "path" }, "enabled": { "type": "boolean", "x-found-in": "body" }, "login_identifier_prefix": { "type": "string", "x-found-in": "body" }, "saml_idp": { "$ref": "_defs.json#/$defs/SamlIdp", "x-found-in": "body" } }, "required": ["organization_id", "enabled", "login_identifier_prefix", "saml_idp"], "$defs": { "IdpConfigurationRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "login_identifier_prefix": { "type": "string" }, "saml_idp": { "$ref": "_defs.json#/$defs/SamlIdp" } }, "required": ["enabled", "login_identifier_prefix", "saml_idp"] } } }

package/lib/cloud/json/shutdown_deployment.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "shutdown-deployment", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "hide": { "type": "boolean", "description": "Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.", "x-found-in": "query" }, "skip_snapshot": { "type": "boolean", "description": "Whether or not to skip snapshots before shutting down the resources", "x-found-in": "query" } }, "required": ["deployment_id"], "$defs": { "DeploymentShutdownResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "orphaned": { "$ref": "_defs.json#/$defs/Orphaned" } }, "required": ["id", "name"] } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "shutdown-deployment", "x-api": { "id": "deployments.shutdown-deployment", "name": "shutdown-deployment", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/_shutdown", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment", "x-found-in": "path" }, "hide": { "type": "boolean", "description": "Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.", "x-found-in": "query" }, "skip_snapshot": { "type": "boolean", "description": "Whether or not to skip snapshots before shutting down the resources", "x-found-in": "query" } }, "required": ["deployment_id"], "$defs": { "DeploymentShutdownResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "orphaned": { "$ref": "_defs.json#/$defs/Orphaned" } }, "required": ["id", "name"] } } }

package/lib/cloud/json/shutdown_deployment_es_resource.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "shutdown-deployment-es-resource", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "hide": { "type": "boolean", "description": "Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.", "x-found-in": "query" }, "skip_snapshot": { "type": "boolean", "description": "If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible).", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "shutdown-deployment-es-resource", "x-api": { "id": "deployments.shutdown-deployment-es-resource", "name": "shutdown-deployment-es-resource", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "hide": { "type": "boolean", "description": "Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.", "x-found-in": "query" }, "skip_snapshot": { "type": "boolean", "description": "If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible).", "x-found-in": "query" } }, "required": ["deployment_id", "ref_id"] }

package/lib/cloud/json/shutdown_deployment_stateless_resource.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "shutdown-deployment-stateless-resource", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "stateless_resource_kind": { "type": "string", "description": "The kind of stateless resource", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "hide": { "type": "boolean", "description": "Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.", "x-found-in": "query" }, "skip_snapshot": { "type": "boolean", "description": "If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)", "x-found-in": "query" } }, "required": ["deployment_id", "stateless_resource_kind", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "shutdown-deployment-stateless-resource", "x-api": { "id": "deployments.shutdown-deployment-stateless-resource", "name": "shutdown-deployment-stateless-resource", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "stateless_resource_kind": { "type": "string", "description": "The kind of stateless resource", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "hide": { "type": "boolean", "description": "Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.", "x-found-in": "query" }, "skip_snapshot": { "type": "boolean", "description": "If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)", "x-found-in": "query" } }, "required": ["deployment_id", "stateless_resource_kind", "ref_id"] }

package/lib/cloud/json/start_deployment_resource_instances.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "start-deployment-resource-instances", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "instance_ids": { "type": "array", "description": "A comma-separated list of instance identifiers.", "x-found-in": "path" }, "ignore_missing": { "type": "boolean", "description": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error", "x-found-in": "query" } }, "required": ["deployment_id", "resource_kind", "ref_id", "instance_ids"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "start-deployment-resource-instances", "x-api": { "id": "deployments.start-deployment-resource-instances", "name": "start-deployment-resource-instances", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" }, "instance_ids": { "type": "array", "description": "A comma-separated list of instance identifiers.", "x-found-in": "path" }, "ignore_missing": { "type": "boolean", "description": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error", "x-found-in": "query" } }, "required": ["deployment_id", "resource_kind", "ref_id", "instance_ids"] }

package/lib/cloud/json/start_deployment_resource_instances_all.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "start-deployment-resource-instances-all", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "resource_kind", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "start-deployment-resource-instances-all", "x-api": { "id": "deployments.start-deployment-resource-instances-all", "name": "start-deployment-resource-instances-all", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "resource_kind", "ref_id"] }

package/lib/cloud/json/start_deployment_resource_instances_all_maintenance_mode.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "start-deployment-resource-instances-all-maintenance-mode", "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "resource_kind", "ref_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "start-deployment-resource-instances-all-maintenance-mode", "x-api": { "id": "deployments.start-deployment-resource-instances-all-maintenance-mode", "name": "start-deployment-resource-instances-all-maintenance-mode", "namespace": "deployments" }, "x-method": "POST", "x-path": "/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start", "x-destructive": true, "type": "object", "properties": { "deployment_id": { "type": "string", "description": "Identifier for the Deployment.", "x-found-in": "path" }, "resource_kind": { "type": "string", "description": "The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).", "x-found-in": "path" }, "ref_id": { "type": "string", "description": "User-specified RefId for the Resource (or '_main' if there is only one).", "x-found-in": "path" } }, "required": ["deployment_id", "resource_kind", "ref_id"] }