# OpenAPI Document

## OpenAPI - R4.8.1 - EN

- [What is Cocktail Open API?](https://cocktailcloud.gitbook.io/openapi-en/readme.md): Cocktail Open API is a management service for external access to the Cocktail service API, including features such as user authentication, restrictions, and statistics
- [API Token Issuance](https://cocktailcloud.gitbook.io/openapi-en/api-information/token.md)
- [API call](https://cocktailcloud.gitbook.io/openapi-en/api-information/api.md): API call refers to the process of requesting a specific action from the Cocktail server.
- [API response](https://cocktailcloud.gitbook.io/openapi-en/api-information/api-response.md): The API response is the data received from the server as a result of the requested Cocktail operation
- [Common](https://cocktailcloud.gitbook.io/openapi-en/api-reference/common.md)
- [Get volume types](https://cocktailcloud.gitbook.io/openapi-en/api-reference/common/volume-type.md)
- [Platform](https://cocktailcloud.gitbook.io/openapi-en/api-reference/platform.md)
- [Get platform](https://cocktailcloud.gitbook.io/openapi-en/api-reference/platform/summaries.md)
- [Get platform service maps](https://cocktailcloud.gitbook.io/openapi-en/api-reference/platform/servicemap-list.md)
- [Cluster](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster.md)
- [Get clusters list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/list.md)
- [Get clusters status list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/condition.md)
- [Get cluster details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/detail.md)
- [Get cluster nodes list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/node-list.md)
- [Get cluster node details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/node-detail.md)
- [Get cluster node events list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/node-event.md)
- [Get cluster storage list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/storage-list.md)
- [Get cluster storage details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/storage-detail.md)
- [Get cluster ingress list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ingress-list.md)
- [Get cluster service exposures list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/svc-exposing-list.md)
- [Get cluster configuration list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/setting-list.md)
- [Get cluster workloads list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/workload-list.md)
- [Get cluster pods list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/pod-list.md)
- [Get cluster PVC list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/volume-list.md)
- [Get cluster CRD list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/crd-list.md)
- [Get cluster addon list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/addon-configmap.md)
- [Get cluster package list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/package.md)
- [Get cluster namespace list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-list.md)
- [Get cluster namespace details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-detail.md)
- [Get cluster namespace ingress list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-ingress-list.md)
- [Get cluster namespace ingress details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-ingress-detail.md)
- [Get cluster namespace service exposure list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-svc-exposing-list.md)
- [Get cluster namespace service exposure details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-svc-exposing-detail.md)
- [Get cluster namespace configmap list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-configmap-list.md)
- [Get cluster namespace configmap details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-configmap-detail.md)
- [Get cluster namespace secret list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-secret-list.md)
- [Get cluster namespace secret details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-secret-detail.md)
- [Get cluster namespace PVC list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-volume-list.md)
- [Get cluster namespace PVC details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-volume-detail.md)
- [Get cluster namespace Cronjobs list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-cronjob.md)
- [Get cluster namespace Cronjob details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-cronjob-detail.md)
- [Get cluster namespace DaemonSets list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-daemonset.md)
- [Get cluster namespace DaemonSet details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-daemonset-detail.md)
- [Get cluster namespace Deployments list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-deployment.md)
- [Get cluster namespace Deployment details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-deployment-detail.md)
- [Get cluster namespace HAPs list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-hpa.md)
- [Get cluster namespace Jobs list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-job.md)
- [Get cluster namespace Job details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-job-detail.md)
- [Get cluster namespace ReplicaSets list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-replicaset.md)
- [Get cluster namespace StatefulSets list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-statefulset.md)
- [Get cluster namespace StatefulSet details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-statefulset-detail.md)
- [Get cluster namespace pods logs](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-pod.md)
- [Get cluster namespace Container log](https://cocktailcloud.gitbook.io/openapi-en/api-reference/cluster/ns-container-log.md)
- [workspaces](https://cocktailcloud.gitbook.io/openapi-en/api-reference/workspace.md)
- [Get workspaces list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/workspace/list.md)
- [Get workspace details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/workspace/detail.md)
- [service map](https://cocktailcloud.gitbook.io/openapi-en/api-reference/servicemap.md)
- [Get workspace service maps list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/servicemap/workspace-servicemap-list.md)
- [Get workspace service map details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/servicemap/workspace-servicemap-detail.md)
- [Get service map workloads list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/servicemap/workload-list.md)
- [Get service map workload details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/servicemap/workload-detail.md)
- [Get service map groups list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/servicemap/group-list.md)
- [pipeline](https://cocktailcloud.gitbook.io/openapi-en/api-reference/pipeline.md)
- [Get pipeline list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/pipeline/list.md)
- [Run pipeline](https://cocktailcloud.gitbook.io/openapi-en/api-reference/pipeline/run.md)
- [Get pipeline Execution Details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/pipeline/run-detail.md)
- [Monitoring](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring.md)
- [Monitoring variables](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-param.md)
- [Monitoring Cluster](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters.md)
- [Get cluster CPU usage trend (Core)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/cpu.md)
- [Get cluster Memory usage trend (Byte)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/memory.md)
- [Get cluster CPU/Memory request trend (Core/Byte)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/quota.md)
- [Get cluster network usage trend (Mbps)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/network.md)
- [Get cluster kube API server request](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/kube-api-server-request.md)
- [Get cluster kube API server average response time](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/kube-http-request-duration.md)
- [Get cluster restart pod list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/pod-restart-list.md)
- [Get cluster restart pod growth rate](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/pod-restart.md)
- [Get cluster pod count trend by status](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/pod-running.md)
- [Get cluster pod CPU usage Top 5 trend (Core)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/pod-cpu-top.md)
- [Get cluster pod Memory usage Top 5 trend (Byte)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-clusters/pod-memory-top.md)
- [Monitoring Node](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes.md)
- [Get cluster node CPU usage trend (%)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/cpu-usage.md)
- [Get cluster node CPU usage trend by status (%)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/cpu-usage-by-mode.md)
- [Get cluster node CPU load trend (Average Core)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/load-transition.md)
- [Get cluster node CPU current load (Core Average)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/load-current.md)
- [Get cluster node Memory usage trend (Byte)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/memory-usage.md)
- [Get cluster node disk free space trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/disk-usage.md)
- [Get cluster node disk I/O rate change trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/disk-io.md)
- [Get cluster node disk detailed usage rate](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/disk-detail-usage.md)
- [Get cluster node network usage (bps)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/network.md)
- [Get cluster node network usage trend by device](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/traffic-by-device.md)
- [Get cluster node uptime](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/uptime.md)
- [Get cluster node availability](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-nodes/capacity.md)
- [Monitoring Ingress](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress.md)
- [Get ingress controller average connection count trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/controller-connections.md)
- [Get ingress controller average request rate trend (ReqPS)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/controller-requests.md)
- [Get ingress controller request success rate trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/controller-success-rate.md)
- [Get ingress controller CPU usage trend (Core)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/ingress-controller-average-cpu-usage.md)
- [Get ingress controller Memory usage trend (MiB)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/ingress-controller-average-memory-usage.md)
- [Get ingress controller network usage trend (kBs)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/controller-network-pressure.md)
- [Get ingress controller config reload count](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/controller-config-reload.md)
- [Get ingress controller config reload success status](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/controller-config-reload-success.md)
- [Get ingress controller request rate trend per ingress](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/ingress-requests.md)
- [Get ingress controller success rate trend per ingress](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/ingress-success-rate.md)
- [Get ingress controller percentile response time and throughput per ingress](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ingress/ingress-percentile-response.md)
- [Monitoring ETCD](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd.md)
- [Get the existence of ETCD Leader](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/leader-count.md)
- [Get the trend of ETCD Leader change count](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/leader-change-rate.md)
- [Get the trend of ETCD Proposal count by state](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/raft-proposals.md)
- [Get the trend of ETCD Proposal failure count](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/proposal-fail-rate.md)
- [Get the trend of CPU usage for ETCD nodes](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/cpu-usage.md)
- [Get the trend of Memory usage for ETCD nodes](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/memory-usage.md)
- [Get the trend of Network transmit and receive volume between ETCD servers](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/network-usage.md)
- [Get the trend of Network transmit and receive volume between ETCD servers by node](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/network-per-node.md)
- [Get the trend of ETCD gRPC call](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/rpc-rate.md)
- [Get the trend of ETCD gRPC Active Streams](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/active-stream.md)
- [Get the trend of ETCD Disk processing wait time](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/disk-sync-duration.md)
- [Get the trend of ETCD Disk processing wait time by node](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/disk-sync-duration-per-node.md)
- [Get the trend of ETCD snapshot save wait time](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/snapshot-duration.md)
- [Get the trend of ETCD DB size](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-etcd/db-size.md)
- [Monitoring Namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns.md)
- [Get namespace creation time](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/created.md)
- [Get namespace CPU total usage (Core)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/total-cpu.md)
- [Get namespace Memory total usage (Byte)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/total-memory.md)
- [Get namespace CPU/Memory total quota](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/quota.md)
- [Get namespace pod CPU usage (Core)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/cpu.md)
- [Get namespace pod Memory usage (Byte)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/memory.md)
- [Get the trend of deployment creation count in namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/deployment-created.md)
- [Get the list of pods in namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pod-list.md)
- [Get the trend of total number of pods in namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/total-pod-count.md)
- [Get the trend of total number of pods by node in namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pod-count-on-node.md)
- [Get pods per namespace QoS](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pod-qos.md)
- [Get the number of ready pods in the namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pod-ready.md)
- [Get trend of restarted pods count in namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pod-restart.md)
- [Get trend of terminated pods count in namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pod-terminated.md)
- [Get trend of waiting pods count in namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pod-waiting.md)
- [Get the total number of PVCs in the namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/total-pvc-count.md)
- [Get trend of PVCs by status in the namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pvc-phase.md)
- [Get namespace PVC usage (Byte)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/volume.md)
- [Get current total CPU/Memory usage in the namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/total-resource.md)
- [Get the number of pods by status in namespace](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-ns/pod-status.md)
- [Monitoring Workload](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload.md)
- [Get total CPU/Memory usage of workloads](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/resource.md)
- [Get workload pod CPU/Memory current quota and usage](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/pod-resource.md)
- [Get workload pod CPU usage trend (Core)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/pod-cpu.md)
- [Get workload CPU Usage (Cores)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/cpu.md)
- [Get workload pod memory usage trend (Bytes)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/pod-memory.md)
- [Get workload memory usage (Bytes)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/memory.md)
- [Get workload CPU/Memory total quota](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/quota.md)
- [Get workload pod network usage trend (bps)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/pod-network.md)
- [Get workload network usage (bps)](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/network.md)
- [Get workload pod CPU/Memory current usage](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-workload/pod-usage.md)
- [Monitoring GPU](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu.md)
- [GPU Temperature Trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/temperature-trend.md)
- [GPU Framebuffer Memory Usage Trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/framebuffer-memory-usage-trend.md)
- [GPU Power Consumption Trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/power-consumption-trend.md)
- [GPU GR Engine Usage Trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/gr-engin-usage-trend.md)
- [GPU Tensor Core Usage Trend](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/tensor-core-usage-trend.md)
- [GPU GR Engine Activation Ratio](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/gr-engine-activation-ratio.md)
- [GPU Framebuffer Memory Usage](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/framebeffer-memory-usage.md)
- [GPU Timeslicing Status](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/timeslicing-status.md)
- [GPU Instances](https://cocktailcloud.gitbook.io/openapi-en/api-reference/monitoring/monitoring-gpu/instances.md)
- [Event](https://cocktailcloud.gitbook.io/openapi-en/api-reference/event.md)
- [Get alarms](https://cocktailcloud.gitbook.io/openapi-en/api-reference/event/alert.md)
- [Get events](https://cocktailcloud.gitbook.io/openapi-en/api-reference/event/event.md)
- [Build](https://cocktailcloud.gitbook.io/openapi-en/api-reference/api-build.md)
- [Create a build](https://cocktailcloud.gitbook.io/openapi-en/api-reference/api-build/build-create.md)
- [Run build - Create a tag](https://cocktailcloud.gitbook.io/openapi-en/api-reference/api-build/build-run.md)
- [Get build execution log](https://cocktailcloud.gitbook.io/openapi-en/api-reference/api-build/build-log.md)
- [Get build image tag list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/api-build/tag-list.md)
- [Delete bulid](https://cocktailcloud.gitbook.io/openapi-en/api-reference/api-build/build-delete.md)
- [Backup/Restore](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup.md)
- [Get backup list](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup/list.md)
- [Get backup details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup/detail.md)
- [Get the list of restore points in Backup Details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup/detail-restorepoint.md)
- [Run backup](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup/run.md)
- [Start/stop the backup execution schedule](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup/schedule-run-pause.md)
- [Get restore point details](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup/restorepoint-detail.md)
- [Get Restore Point Resource List](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup/restorepoint-resource.md)
- [Get restore point logs](https://cocktailcloud.gitbook.io/openapi-en/api-reference/backup/restorepoint-log.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://cocktailcloud.gitbook.io/openapi-en/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
