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.
- Base URL
-
https://api.elastic-cloud.com - Version
- 0.1.0
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.
The Project Management API is documented using the OpenAPI Specification. The current supported version of the specification is 3.0. For details, check the API reference or download the OpenAPI Specification. This specification can be used to generate client SDKs, or on tools that support it, such as the Swagger Editor.
This documentation is derived from a private repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.
Capabilities 1
Elasticsearch projects 11
-
GET
Get Elasticsearch projects
/api/v1/serverless/projects/elasticsearch -
POST
Create an Elasticsearch project
/api/v1/serverless/projects/elasticsearch -
GET
Get an Elasticsearch project
/api/v1/serverless/projects/elasticsearch/{id} -
PATCH
Update an Elasticsearch project
/api/v1/serverless/projects/elasticsearch/{id} -
DELETE
Delete an Elasticsearch project
/api/v1/serverless/projects/elasticsearch/{id} -
GET
Get Elasticsearch project delete status
/api/v1/serverless/projects/elasticsearch/{id}/_can-delete -
POST
Reset the project credentials
/api/v1/serverless/projects/elasticsearch/{id}/_reset-credentials -
POST
Resume Elasticsearch project
/api/v1/serverless/projects/elasticsearch/{id}/_resume -
GET
Get Elasticsearch project link candidates
/api/v1/serverless/projects/elasticsearch/{id}/link-candidates -
GET
Get roles for an Elasticsearch project
/api/v1/serverless/projects/elasticsearch/{id}/roles -
GET
Get the status of an Elasticsearch project
/api/v1/serverless/projects/elasticsearch/{id}/status
Monitoring 2
Observability projects 11
-
GET
Get Observability projects
/api/v1/serverless/projects/observability -
POST
Create an observability project
/api/v1/serverless/projects/observability -
GET
Get an Observability project
/api/v1/serverless/projects/observability/{id} -
PATCH
Update an Observability project
/api/v1/serverless/projects/observability/{id} -
DELETE
Delete an Observability project
/api/v1/serverless/projects/observability/{id} -
GET
Get Observability project delete status
/api/v1/serverless/projects/observability/{id}/_can-delete -
POST
Reset the project credentials
/api/v1/serverless/projects/observability/{id}/_reset-credentials -
POST
Resume Observability project
/api/v1/serverless/projects/observability/{id}/_resume -
GET
Get Observability project link candidates
/api/v1/serverless/projects/observability/{id}/link-candidates -
GET
Get roles for an Observability project
/api/v1/serverless/projects/observability/{id}/roles -
GET
Get the status of an Observability project
/api/v1/serverless/projects/observability/{id}/status
Regions 2
Security projects 11
-
GET
Get Security projects
/api/v1/serverless/projects/security -
POST
Create a security project
/api/v1/serverless/projects/security -
GET
Get a Security project
/api/v1/serverless/projects/security/{id} -
PATCH
Update a Security project
/api/v1/serverless/projects/security/{id} -
DELETE
Delete a Security project
/api/v1/serverless/projects/security/{id} -
GET
Get Security project delete status
/api/v1/serverless/projects/security/{id}/_can-delete -
POST
Reset the project credentials
/api/v1/serverless/projects/security/{id}/_reset-credentials -
POST
Resume Security project
/api/v1/serverless/projects/security/{id}/_resume -
GET
Get Security project link candidates
/api/v1/serverless/projects/security/{id}/link-candidates -
GET
Get roles for a Security project
/api/v1/serverless/projects/security/{id}/roles -
GET
Get the status of a Security project
/api/v1/serverless/projects/security/{id}/status
Traffic filters 6
-
GET
List traffic filters
/api/v1/serverless/traffic-filters -
POST
Create a traffic filter
/api/v1/serverless/traffic-filters -
GET
List PrivateLink region metadata
/api/v1/serverless/traffic-filters/metadata -
GET
Retrieves the traffic filter by ID.
/api/v1/serverless/traffic-filters/{id} -
PATCH
Updates a traffic filter
/api/v1/serverless/traffic-filters/{id} -
DELETE
Delete a traffic filter
/api/v1/serverless/traffic-filters/{id}
Vectordb projects 11
-
GET
Get VectorDB projects
/api/v1/serverless/projects/vectordb -
POST
Create a VectorDB project
/api/v1/serverless/projects/vectordb -
GET
Get a VectorDB project
/api/v1/serverless/projects/vectordb/{id} -
PATCH
Update a VectorDB project
/api/v1/serverless/projects/vectordb/{id} -
DELETE
Delete a VectorDB project
/api/v1/serverless/projects/vectordb/{id} -
GET
Get VectorDB project delete status
/api/v1/serverless/projects/vectordb/{id}/_can-delete -
POST
Reset the project credentials
/api/v1/serverless/projects/vectordb/{id}/_reset-credentials -
POST
Resume VectorDB project
/api/v1/serverless/projects/vectordb/{id}/_resume -
GET
Get VectorDB project link candidates
/api/v1/serverless/projects/vectordb/{id}/link-candidates -
GET
Get roles for a VectorDB project
/api/v1/serverless/projects/vectordb/{id}/roles -
GET
Get the status of a VectorDB project
/api/v1/serverless/projects/vectordb/{id}/status