Update a Security project

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

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

Headers

If-Match string

ETag value fetched in a previous GET project request. Used to prevent simultaneous updates

Path parameters

id string Required

The ID of the project

Format should match the following pattern: ^[a-z0-9]{32}$.

application/json

Body Required

The patched Security project

name string

Descriptive name for a project.

Minimum length is 1, maximum length is 255.
alias string

A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.

Minimum length is 1, maximum length is 50. Format should match the following pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$.
admin_features_package string | null

admin features package (BYOK, BYOIDP, CCS, CCR). It can be passed as null to reset the admin features package to the default value.

Values are standard or enterprise.
product_types array[object] | null

At least 1 but not more than 3 elements.
Hide product_types attributes Show product_types attributes object
- product_line string Required
  
  The identifier of the Security Solution product line.
  
  Values are security, cloud, or endpoint.
- product_tier string Required
  
  The identifier of the Security Solution product tier.
  
  Values are complete or essentials.
search_lake object | null

Configuration for the entire set of capabilities that make the data searchable in Security.

Additional properties are allowed.
Hide search_lake attribute Show search_lake attribute object | null
- data_retention object | null
  
  Configuration to control the data retention in Elasticsearch data streams.
  
  Additional properties are allowed.
  Hide data_retention attributes Show data_retention attributes object | null
  
  max_retention_days integer | null
  
  Maximum number of days allowed for retaining data in Elasticsearch data streams. Can be set to "null" for unlimited. A default of 396 will be applied if no value is specified on project creation.
  
  Minimum value is 7, maximum value is 3681.
  
  default_retention_days integer | null
  
  Default number of days during which data remains available in Elasticsearch data streams. Can be set to "null" for unlimited. A default of 396 will be applied if no value is specified on project creation.
  
  Minimum value is 7, maximum value is 3681.

Responses

200 application/json

The updated Security project.
Hide headers attribute Show headers attribute
- ETag string
Hide response attributes Show response attributes object
A Security project.
- id string Required
  
  ID of the project.
  
  Format should match the following pattern: ^[a-z0-9]{32}$.
- name string Required
  
  Descriptive name for a project.
  
  Minimum length is 1, maximum length is 255.
- alias string Required
  
  A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
  
  Minimum length is 1, maximum length is 50. Format should match the following pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$.
- region_id string Required
  
  Unique human-readable identifier for a region in Elastic Cloud.
- metadata object Required
  
  Additional details about the project.
  
  Additional properties are allowed.
  
  Hide metadata attributes Show metadata attributes object
  
  created_at string(date-time) Required
  
  Date and time when the project was created.
  
  created_by string Required
  
  ID of the user.
  
  organization_id string Required
  
  The Organization ID who owns the project.
  
  suspended_at string(date-time)
  
  Date and time when the project was suspended.
  
  suspended_reason string
  
  Reason why the project was suspended.
- 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.
- type string Required
  
  the type of the project
  
  Value is security.
- endpoints object Required
  
  The endpoints to access the different apps of the project.
  
  Additional properties are allowed.
  
  Hide endpoints attributes Show endpoints attributes object
  
  elasticsearch string Required
  
  The endpoint to access elasticsearch.
  
  kibana string Required
  
  The endpoint to access kibana.
- search_lake object
  
  Configuration for the entire set of capabilities that make the data searchable in Security.
  
  Additional properties are allowed.
  
  Hide search_lake attribute Show search_lake attribute object
  
  data_retention object | null
  
  Configuration to control the data retention in Elasticsearch data streams.
  
  Additional properties are allowed.
  
  Hide data_retention attributes Show data_retention attributes object | null
  
  max_retention_days integer | null
  
  Maximum number of days allowed for retaining data in Elasticsearch data streams. Can be set to "null" for unlimited. A default of 396 will be applied if no value is specified on project creation.
  
  Minimum value is 7, maximum value is 3681.
  
  default_retention_days integer | null
  
  Default number of days during which data remains available in Elasticsearch data streams. Can be set to "null" for unlimited. A default of 396 will be applied if no value is specified on project creation.
  
  Minimum value is 7, maximum value is 3681.
- admin_features_package string
  
  admin features package (BYOK, BYOIDP, CCS, CCR)
  
  Values are standard or enterprise.
- product_types array[object]
  
  At least 2 but not more than 3 elements. Default value is [{"product_line"=>"security", "product_tier"=>"complete"}, {"product_line"=>"cloud", "product_tier"=>"complete"}, {"product_line"=>"endpoint", "product_tier"=>"complete"}].
  
  Hide product_types attributes Show product_types attributes object
  
  product_line string Required
  
  The identifier of the Security Solution product line.
  
  Values are security, cloud, or endpoint.
  
  product_tier string Required
  
  The identifier of the Security Solution product tier.
  
  Values are complete or essentials.
404 application/json

Not Found
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  A human-readable message of the error.
  
  code string Required
  
  An identifier for this type of error.
409 application/json

Conflict
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  A human-readable message of the error.
  
  code string Required
  
  An identifier for this type of error.
412 application/json

Precondition failed
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  A human-readable message of the error.
  
  code string Required
  
  An identifier for this type of error.

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

curl \
 -X PATCH https://api.elastic-cloud.com/api/v1/serverless/projects/security/{id} \
 -H "Content-Type: application/json" \
 -H "If-Match: string" \
 -d '{"name":"Example project"}'

Request example

{
  "name": "Example project"
}

Response examples (200)

# 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"
    }
  ]
}

Response examples (404)

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}

Response examples (409)

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}

Response examples (412)

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}