Update a Security project

Base URL: https://api.elastic-cloud.com

PATCH /api/v1/serverless/projects/security/{id}

Only the fields included in the body of the request will be updated.

Authentication

Authorization: <value>

API keys are used to authenticate requests to the Elastic Cloud Serverless REST API. Generate your secret API key in https://cloud.elastic.co/account/keys You must provide the API key for all API requests in the Authorization header as follows:

"Authorization: ApiKey $API_KEY"

For example, if you interact with the API using the curl command:

		curl -H "Authorization: ApiKey essu_..." https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch
		
	

Path parameters

Header parameters

Request body

The patched Security project

name string · min length: 1 · max length: 255: Descriptive name for a project.
alias string · min length: 1 · max length: 50 · pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$: A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
admin_features_package enum nullable: admin features package (BYOK, BYOIDP, CCS, CCR). Pass null to reset the admin features package to the default value.; Values: standard enterprise
product_types object[] · min items: 1 · max items: 3 nullable
search_lake object nullable: Configuration for the entire set of capabilities that make the data searchable in Security.
traffic_filters object[] nullable: traffic filters IDs
metadata object: Metadata about the project
linked object nullable: Configuration for projects linked to this project

Responses

The updated Security project.

application/json

id string · pattern: ^[a-z0-9]{32}$ required: ID of the project.
name string · min length: 1 · max length: 255 required: Descriptive name for a project.
alias string · min length: 8 · max length: 57 · pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$ required: A domain label compatible with RFC-1035 standards. Project alias with a unique suffix added by the system to avoid naming conflicts.
region_id string required: Unique human-readable identifier for a region in Elastic Cloud.
metadata object required: Additional details about the project.
cloud_id string required: The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
traffic_filters object[]: traffic filters IDs
linked object: Configuration for projects linked to this project
type enum required: the type of the project; Values: security
endpoints object required: The endpoints to access the different apps of the project.
private_endpoints object: Private endpoints (URLs) for Security projects when PrivateLink is enabled.
search_lake object: Configuration for the entire set of capabilities that make the data searchable in Security.
admin_features_package enum: admin features package (BYOK, BYOIDP, CCS, CCR); Values: standard enterprise
product_types object[] · min items: 1 · max items: 3 · default: [ { "product_line": "security", "product_tier": "complete" }, { "product_line": "cloud", "product_tier": "complete" }, { "product_line": "endpoint", "product_tier": "complete" } ]

Response headers

ETag string

Not Found

application/json

Conflict

application/json

Precondition failed

application/json

Authentication

Path parameters

Header parameters

Request body { }

Responses

Response headers

Request body