API Index

Find the API specifications you need by endpoint, and check the base URL and request details required to call each API.

Search all APIs

Use the search function at the top of the page to search all API specifications by API name or resource name. Select an API from the results to open its request details and full specification.

APIs by endpoint

Select an endpoint to view its APIs and primary resources. Each specification provides the HTTP method, request path, parameters, and response schema.

Construct the request URL by appending the individual API path to the base URL. For details, see Constructing an API request URL.

Documentation by endpoint	Primary operations
Beyond Compute Service	Manage instances and keypairs; attach volumes, network interfaces, and public IPs to instances
Image	View, update, delete, and share images across projects
Volume	Manage volumes and snapshots; create images from volumes
VPC	Manage VPCs, subnets, route tables, and network interfaces
Network	Manage public IPs and security groups
Load Balancer	Manage load balancers, listeners, target groups, and health checks
Transit Gateway	Manage Transit Gateway connections, sharing, and routes
Kubernetes Engine	Manage clusters and node pools, scaling, and version upgrades
MySQL	Operate instance groups, backups, and parameter groups
File Storage	Manage Basic and Infinite file systems, backups, and shared volumes
KMS	Manage key lifecycles and access; encrypt and sign data
Secrets Manager	Manage secret and version lifecycles and access
Resource Explorer	View project resources and tags

VPC & Network endpoint distinction

The VPC & Network sidebar item combines APIs from two endpoints so that related networking resources can be found in one place. Although they share one navigation item, requests use different hosts. Do not infer the request host from the documentation path; use the base URL shown in the individual API specification.

Both endpoint APIs appear in the same list, so use the following host distinction:

• vpc: VPCs, subnets, route tables, internet gateways, and network interfaces
• network: public IPs, security groups, and security group rules

Select an endpoint for the operation

Operations involving the same resource may use one endpoint to manage the resource itself and another to attach it to a different resource. The following cases are common.

Operation	Request endpoint	API documentation
Create, view, or delete a volume	volume	Volume APIs
Attach or detach a volume from an instance	bcs	Attach volume, Detach volume
Create and manage a network interface	vpc	Network interface APIs
Manage public IPs and security groups	network	Public IPs, Security groups
Associate a public IP with an instance	bcs	Associate public IP
Associate a public IP with a load balancer	load-balancer	Associate public IP

After selecting an endpoint, verify the following:

1. The base URL, HTTP method, and request path in the API specification
2. Required path, query, and request body parameters
3. Success and error responses, including resource IDs needed for follow-up operations
4. The API authentication token passed in the request header