Each EZGH Cloud product has its own HTTPS API host. The APIs share authentication, errors, pagination and other conventions, described in this section.
- Authentication: API keys, CLI logins and console sessions.
- Errors: the error body and status codes.
- Requests: pagination, idempotency keys, conditional writes, timestamps and money.
Hosts
| Product | Base URL | Reference |
|---|---|---|
| Organizations and IAM | https://orgs.ezghcloud.com |
Organizations API |
| Billing | https://billing.ezghcloud.com |
Billing API |
| Trails | https://trails.ezghcloud.com |
Trails API |
| Notifications | https://notifications.ezghcloud.com |
Notifications API |
| Service quotas | https://quotas.ezghcloud.com |
Service quotas API |
| EZGH SSO | https://sso.ezghcloud.com |
EZGH SSO API |
| Secrets | https://secrets.ezghcloud.com |
Secrets API |
| Observability | https://obs.ezghcloud.com |
Observability API |
| Workflows | https://workflows-api.ezghcloud.com |
Workflows API |
| Feature Flags | https://flags-api.ezghcloud.com |
Feature Flags API |
| Queues | https://queues-api.ezghcloud.com (receive and receipts: https://queues-live.ezghcloud.com) |
Queues API |
| Hosted Queues | https://hostedqueues-api.ezghcloud.com |
Hosted Queues API |
| Private CA | https://certificates.ezghcloud.com |
Certificates API |
| Compute | https://compute-api.ezghcloud.com |
Compute API |
| Block Storage | https://blockstore-api.ezghcloud.com |
Block Storage API |
| Network | https://network-api.ezghcloud.com |
Network API |
| Firewall | https://firewall-api.ezghcloud.com |
Firewall API |
| Load Balancers | https://lb-api.ezghcloud.com |
Load Balancers API |
| WAF | https://waf-api.ezghcloud.com |
WAF API |
| CDN | https://cdn.ezghcloud.com |
CDN API |
| Databases | https://databases-api.ezghcloud.com |
Databases API |
| Caches | https://caches-api.ezghcloud.com |
Caches API |
| Warehouse | https://warehouse-api.ezghcloud.com |
Warehouse API |
| Files | https://files-api.ezghcloud.com |
Files API |
| Git | https://git-api.ezghcloud.com |
Git API |
| Build | https://build.ezghcloud.com |
Build API |
| Deploy | https://deploy.ezghcloud.com |
Deploy API |
| Container Registry | https://registry-api.ezghcloud.com (images: https://<id>.registry.ezghcloud.com) |
Container Registry API |
| Kubernetes | https://kubernetes-api.ezghcloud.com |
Kubernetes API |
| Sandboxes | https://sandboxes.ezghcloud.com |
Sandboxes API |
| Run | https://run.ezghcloud.com (services: https://<name>-<id>.run.us-west-1.ezghapps.com) |
Run API |
| Object Storage | https://objects.ezghcloud.com (S3 API: https://s3.us-west-1.ezghapps.com) |
Object Storage API |
| DNS | https://dns-api.ezghcloud.com |
DNS API |
| Domains | https://domains-api.ezghcloud.com |
Domains API |
| Fleets | https://fleets-api.ezghcloud.com |
Fleets API |
The Trails API also answers at its earlier address, https://audit.ezghcloud.com.
Paths
- Paths start with the major version,
/v1. - Almost every path names the organization:
/v1/organizations/{orgId}/…. Project-scoped resources add the project:/v1/organizations/{orgId}/projects/{projectId}/…. Listing and creating organizations (/v1/organizations) are the exceptions. - IDs in paths are UUIDs, not slugs. A malformed ID returns
404, like an unknown one.
Versioning
Within /v1, changes are additive: new endpoints, new optional request fields, new response
fields, new error codes, and new values in enums that are open to extension. Ignore response
fields you don’t recognize. A breaking change gets a new major version.
OpenAPI documents
Each host serves an OpenAPI 3.1 document of its API at /openapi.json, without authentication:
curl https://orgs.ezghcloud.com/openapi.jsonOperation IDs match the eventName of the operation’s Trails events, such as
CreateProject.