Create a security project
The response will include the created project details, such as the project ID, the credentials to access the project, and the endpoints to access different apps such as Elasticsearch and Kibana. The credentials can be regenerated at any time using the _reset-credentials endpoint.
Body Required
Configuration of the security project to create.
-
Descriptive name for a project.
Minimum length is
1
, maximum length is255
. -
alias string
A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
Minimum length is
1
, maximum length is50
. Format should match the following pattern:^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$
. -
Unique human-readable identifier for a region in Elastic Cloud.
-
admin_features_package string
admin features package (BYOK, BYOIDP, CCS, CCR)
Values are
standard
orenterprise
. -
product_types array[object]
At least
2
but not more than3
elements. Default value is[{"product_line"=>"security", "product_tier"=>"complete"}, {"product_line"=>"cloud", "product_tier"=>"complete"}, {"product_line"=>"endpoint", "product_tier"=>"complete"}]
. -
search_lake object
Configuration for the entire set of capabilities that make the data searchable in Security.
Additional properties are allowed.
curl \
-X POST https://api.elastic-cloud.com/api/v1/serverless/projects/security \
-H "Content-Type: application/json" \
-d '{"name":"Example project","region_id":"aws-us-east-1"}'
{
"name": "Example project",
"region_id": "aws-us-east-1"
}
# Headers
ETag: string
# Payload
{
"id": "string",
"name": "my project",
"alias": "my-project-alias",
"region_id": "aws-us-east-1",
"metadata": {
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "1014289666002276",
"organization_id": "198583657190",
"suspended_at": "2024-05-04T09:42:00+00:00",
"suspended_reason": "trial expired"
},
"cloud_id": "my_project:LmF3cy5lbGFzdG",
"type": "security",
"endpoints": {
"elasticsearch": "string",
"kibana": "string"
},
"search_lake": {
"data_retention": {
"max_retention_days": 42,
"default_retention_days": 42
}
},
"admin_features_package": "standard",
"product_types": [
{
"product_line": "security",
"product_tier": "complete"
}
],
"credentials": {
"username": "admin",
"password": "*****"
}
}
{
"errors": [
{
"message": "Explicative error message",
"code": "code.error"
}
]
}
{
"errors": [
{
"message": "Explicative error message",
"code": "code.error"
}
]
}