Skip to content

Commit 9088070

Browse files
committed
Updates structure
1 parent 2ad8845 commit 9088070

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

docs/reference/elasticsearch/rest-apis/elastic-cloud-serverless-api.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,19 @@ navigation_title: Serverless Project Management API
1111

1212
# Elastic Cloud Serverless Project Management API [serverless-project-management-api]
1313

14-
You can manage serverless projects using the [Elastic Cloud Serverless Project Management APIs](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/).
14+
On this page, you can find examples of how to interact with the [Elastic Cloud Serverless Project Management APIs](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/).
15+
16+
To learn about API principles, authentication, and how to use the OpenAPI specification, refer to the [Elastic Cloud Serverless Project Management APIs](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/) documentation.
1517

1618
The available APIs are grouped by project type:
1719

1820
- APIs for [Search projects](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/group/endpoint-elasticsearch-projects)
1921
- APIs for [Observatibility projects](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/group/endpoint-observability-projects)
2022
- APIs for [Security projects](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/group/endpoint-security-projects)
2123

22-
The following examples show how to interact with the APIs, covering common operations such as:
23-
- [Creating a project](#general-manage-project-with-api-create-a-serverless-elasticsearch-project)
24-
- [Retrieving project details](#general-manage-project-with-api-get-project)
25-
- [Retrieving the project's status](#general-manage-project-with-api-get-project-status)
26-
- [Resetting credentials](#general-manage-project-with-api-reset-credentials)
27-
- [Deleting a project](#general-manage-project-with-api-delete-project)
28-
- [Updating a project](#general-manage-project-with-api-update-project)
29-
- [Listing regions where projects can be created](#general-manage-project-with-api-list-available-regions)
24+
To try the examples in this section, [set up an API key](#general-manage-project-with-api-set-up-api-key) and [create an {{es-serverless}} project](#general-manage-project-with-api-create-a-serverless-elasticsearch-project).
3025

31-
## Set up an API key
26+
## Set up an API key [general-manage-project-with-api-set-up-api-key]
3227

3328
1. [Create an API key](https://www.elastic.co/docs/deploy-manage/api-keys/elastic-cloud-api-keys).
3429
2. Store the generated API key as an environment variable so that you don’t need to specify it again for each request:
@@ -76,7 +71,19 @@ You can store the project ID as an environment variable for the next requests:
7671
export PROJECT_ID=cace8e65457043698ed3d99da2f053f6
7772
```
7873

79-
## Get project [general-manage-project-with-api-get-project]
74+
## API examples
75+
76+
The following examples show how to interact with the APIs, covering common operations such as:
77+
78+
- [Creating a project](#general-manage-project-with-api-create-a-serverless-elasticsearch-project)
79+
- [Retrieving project details](#general-manage-project-with-api-get-project)
80+
- [Retrieving the project's status](#general-manage-project-with-api-get-project-status)
81+
- [Resetting credentials](#general-manage-project-with-api-reset-credentials)
82+
- [Deleting a project](#general-manage-project-with-api-delete-project)
83+
- [Updating a project](#general-manage-project-with-api-update-project)
84+
- [Listing regions where projects can be created](#general-manage-project-with-api-list-available-regions)
85+
86+
### Get project [general-manage-project-with-api-get-project]
8087

8188
You can retrieve your project details through an API call:
8289

@@ -85,7 +92,7 @@ curl -H "Authorization: ApiKey $API_KEY" \
8592
"https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/${PROJECT_ID}"
8693
```
8794

88-
## Get project status [general-manage-project-with-api-get-project-status]
95+
### Get project status [general-manage-project-with-api-get-project-status]
8996

9097
The 'status' endpoint indicates whether the project is initialized and ready to be used. In the response, the project's `phase` will change from "initializing" to "initialized" when it is ready:
9198

@@ -102,7 +109,7 @@ Example response:
102109
}
103110
```
104111

105-
## Reset Credentials [general-manage-project-with-api-reset-credentials]
112+
### Reset Credentials [general-manage-project-with-api-reset-credentials]
106113

107114
If you lose the credentials provided at the time of the project creation, you can reset the credentials by using the following endpoint:
108115

@@ -112,7 +119,7 @@ curl -H "Authorization: ApiKey $API_KEY" \
112119
"https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/${PROJECT_ID}/_reset-credentials"
113120
```
114121

115-
## Delete Project [general-manage-project-with-api-delete-project]
122+
### Delete Project [general-manage-project-with-api-delete-project]
116123

117124
You can delete your project via the API:
118125

@@ -121,7 +128,7 @@ curl -XDELETE -H "Authorization: ApiKey $API_KEY" \
121128
"https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/${PROJECT_ID}"
122129
```
123130

124-
## Update Project [general-manage-project-with-api-update-project]
131+
### Update Project [general-manage-project-with-api-update-project]
125132

126133
You can update your project using a PATCH request. Only the fields included in the body of the request will be updated.
127134

@@ -135,7 +142,7 @@ curl -H "Authorization: ApiKey $API_KEY" \
135142
}'
136143
```
137144

138-
## List available regions [general-manage-project-with-api-list-available-regions]
145+
### List available regions [general-manage-project-with-api-list-available-regions]
139146

140147
You can obtain the list of regions where projects can be created using the API:
141148

0 commit comments

Comments
 (0)