--- type: api title: Elastic Cloud Serverless API description: This API enables you to manage Elastic Cloud Serverless Projects. url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless products: - Elastic Cloud Serverless --- # Elastic Cloud Serverless API This API enables you to manage Elastic Cloud Serverless Projects. You can create, update, and delete projects, as well as manage project features and usage. You can find more information and examples using this API in the [documentation](https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/manage-serverless-projects-using-api). ## API principles The Elastic Cloud Serverless REST API is built following REST principles: * Resources (such as projects) are represented as URIs. * Standard HTTP response codes and verbs are used (GET, POST, PUT, PATCH and DELETE). * API calls are stateless. Every request that you make happens in isolation from other calls and must include all the information necessary to fulfill the request. * JSON is the data interchange format. ## Open API Specification The Project Management API is documented using the [OpenAPI Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification). The current supported version of the specification is 3.0. For details, check the [API reference](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/) or download the [OpenAPI Specification](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless.yaml). This specification can be used to generate client SDKs, or on tools that support it, such as the [Swagger Editor](https://editor.swagger.io/). ## Documentation source and versions This documentation is derived from a private repository. It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/). - [Authentication](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/authentication) - [Servers](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/servers) ### [capabilities](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/group/endpoint-capabilities) - [Get organization capabilities](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getorganizationcapabilities): `GET` `/api/v1/serverless/capabilities` ### [elasticsearch projects](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/group/endpoint-elasticsearch-projects) - [Get Elasticsearch projects](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-listelasticsearchprojects): `GET` `/api/v1/serverless/projects/elasticsearch` - [Create an Elasticsearch project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-createelasticsearchproject): `POST` `/api/v1/serverless/projects/elasticsearch` - [Get an Elasticsearch project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getelasticsearchproject): `GET` `/api/v1/serverless/projects/elasticsearch/{id}` - [Update an Elasticsearch project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-patchelasticsearchproject): `PATCH` `/api/v1/serverless/projects/elasticsearch/{id}` - [Delete an Elasticsearch project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-deleteelasticsearchproject): `DELETE` `/api/v1/serverless/projects/elasticsearch/{id}` - [Get Elasticsearch project delete status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getelasticsearchprojectcandelete): `GET` `/api/v1/serverless/projects/elasticsearch/{id}/_can-delete` - [Reset the project credentials](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-resetelasticsearchprojectcredentials): `POST` `/api/v1/serverless/projects/elasticsearch/{id}/_reset-credentials` - [Resume Elasticsearch project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-resumeelasticsearchproject): `POST` `/api/v1/serverless/projects/elasticsearch/{id}/_resume` - [Get Elasticsearch project link candidates](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getelasticsearchprojectlinkcandidates): `GET` `/api/v1/serverless/projects/elasticsearch/{id}/link-candidates` - [Get roles for an Elasticsearch project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getelasticsearchprojectroles): `GET` `/api/v1/serverless/projects/elasticsearch/{id}/roles` - [Get the status of an Elasticsearch project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getelasticsearchprojectstatus): `GET` `/api/v1/serverless/projects/elasticsearch/{id}/status` ### [observability projects](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/group/endpoint-observability-projects) - [Get Observability projects](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-listobservabilityprojects): `GET` `/api/v1/serverless/projects/observability` - [Create an observability project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-createobservabilityproject): `POST` `/api/v1/serverless/projects/observability` - [Get an Observability project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getobservabilityproject): `GET` `/api/v1/serverless/projects/observability/{id}` - [Update an Observability project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-patchobservabilityproject): `PATCH` `/api/v1/serverless/projects/observability/{id}` - [Delete an Observability project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-deleteobservabilityproject): `DELETE` `/api/v1/serverless/projects/observability/{id}` - [Get Observability project delete status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getobservabilityprojectcandelete): `GET` `/api/v1/serverless/projects/observability/{id}/_can-delete` - [Reset the project credentials](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-resetobservabilityprojectcredentials): `POST` `/api/v1/serverless/projects/observability/{id}/_reset-credentials` - [Resume Observability project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-resumeobservabilityproject): `POST` `/api/v1/serverless/projects/observability/{id}/_resume` - [Get Observability project link candidates](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getobservabilityprojectlinkcandidates): `GET` `/api/v1/serverless/projects/observability/{id}/link-candidates` - [Get roles for an Observability project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getobservabilityprojectroles): `GET` `/api/v1/serverless/projects/observability/{id}/roles` - [Get the status of an Observability project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getobservabilityprojectstatus): `GET` `/api/v1/serverless/projects/observability/{id}/status` ### [regions](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/group/endpoint-regions) - [Get regions](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-listregions): `GET` `/api/v1/serverless/regions` - [Get a region](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getregion): `GET` `/api/v1/serverless/regions/{id}` ### [security projects](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/group/endpoint-security-projects) - [Get Security projects](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-listsecurityprojects): `GET` `/api/v1/serverless/projects/security` - [Create a security project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-createsecurityproject): `POST` `/api/v1/serverless/projects/security` - [Get a Security project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getsecurityproject): `GET` `/api/v1/serverless/projects/security/{id}` - [Update a Security project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-patchsecurityproject): `PATCH` `/api/v1/serverless/projects/security/{id}` - [Delete a Security project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-deletesecurityproject): `DELETE` `/api/v1/serverless/projects/security/{id}` - [Get Security project delete status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getsecurityprojectcandelete): `GET` `/api/v1/serverless/projects/security/{id}/_can-delete` - [Reset the project credentials](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-resetsecurityprojectcredentials): `POST` `/api/v1/serverless/projects/security/{id}/_reset-credentials` - [Resume Security project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-resumesecurityproject): `POST` `/api/v1/serverless/projects/security/{id}/_resume` - [Get Security project link candidates](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getsecurityprojectlinkcandidates): `GET` `/api/v1/serverless/projects/security/{id}/link-candidates` - [Get roles for a Security project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getsecurityprojectroles): `GET` `/api/v1/serverless/projects/security/{id}/roles` - [Get the status of a Security project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getsecurityprojectstatus): `GET` `/api/v1/serverless/projects/security/{id}/status` ### [traffic filters](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/group/endpoint-traffic-filters) - [List traffic filters](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-listtrafficfilters): `GET` `/api/v1/serverless/traffic-filters` - [Create a traffic filter](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-createtrafficfilter): `POST` `/api/v1/serverless/traffic-filters` - [List PrivateLink region metadata](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-gettrafficfiltermetadata): `GET` `/api/v1/serverless/traffic-filters/metadata` - [Retrieves the traffic filter by ID.](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-gettrafficfilter): `GET` `/api/v1/serverless/traffic-filters/{id}` - [Updates a traffic filter](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-patchtrafficfilter): `PATCH` `/api/v1/serverless/traffic-filters/{id}` - [Delete a traffic filter](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-deletetrafficfilter): `DELETE` `/api/v1/serverless/traffic-filters/{id}` ### [vectordb projects](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/group/endpoint-vectordb-projects) - [Get VectorDB projects](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-listvectordbprojects): `GET` `/api/v1/serverless/projects/vectordb` - [Create a VectorDB project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-createvectordbproject): `POST` `/api/v1/serverless/projects/vectordb` - [Get a VectorDB project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getvectordbproject): `GET` `/api/v1/serverless/projects/vectordb/{id}` - [Update a VectorDB project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-patchvectordbproject): `PATCH` `/api/v1/serverless/projects/vectordb/{id}` - [Delete a VectorDB project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-deletevectordbproject): `DELETE` `/api/v1/serverless/projects/vectordb/{id}` - [Get VectorDB project delete status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getvectordbprojectcandelete): `GET` `/api/v1/serverless/projects/vectordb/{id}/_can-delete` - [Reset the project credentials](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-resetvectordbprojectcredentials): `POST` `/api/v1/serverless/projects/vectordb/{id}/_reset-credentials` - [Resume VectorDB project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-resumevectordbproject): `POST` `/api/v1/serverless/projects/vectordb/{id}/_resume` - [Get VectorDB project link candidates](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getvectordbprojectlinkcandidates): `GET` `/api/v1/serverless/projects/vectordb/{id}/link-candidates` - [Get roles for a VectorDB project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getvectordbprojectroles): `GET` `/api/v1/serverless/projects/vectordb/{id}/roles` - [Get the status of a VectorDB project](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/cloud-serverless/operation/operation-getvectordbprojectstatus): `GET` `/api/v1/serverless/projects/vectordb/{id}/status`