The RESTful API allows CRUD (Create, Read, Update, and Delete) operations, which are the same concepts behind every modern web application. For more details, please refer to https://en.wikipedia.org/wiki/Create,_read,_update_and_delete.
According to the CRUD structure, the Kubernetes RESTful API has the following basic method:
|
Operation |
HTTP Method |
Example |
|
Create |
POST |
POST /api/v1/namespaces/default/pods |
|
Read |
GET |
GET /api/v1/componentstatuses |
|
Update |
PUT |
PUT /apis/apps/v1/namespaces/default/deployments/my-nginx |
|
Delete |
DELETE |
DELETE /api/v1/namespaces/default/services/nginx-service |
As we mentioned in the recipe Working with configuration files in Chapter 3, Playing with Containers, Kubernetes builds the RESTful API with swagger (https://swagger.io/) and OpenAPI (https://www.openapis.org). We can open the swagger UI console of your cluster to check the API functions. Nevertheless, it is recommended that you check them through the official website, the one we demonstrated in the last section. The description on the website is more elaborate and user-friendly.