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://audit.ezghcloud.com |
Trails API |
| Service quotas | https://quotas.ezghcloud.com |
Service quotas API |
| OCR | https://ocr.ezghcloud.com |
OCR API |
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://ocr.ezghcloud.com/openapi.jsonOperation IDs match the eventName of the operation’s Trails events, such as
CreateProject.