API: Catalog

The catalog endpoints are public and need no key. Plans show the real provider and the provider's own plan name.

List plans

GET /catalog/plans

Returns purchasable plans with the real provider and plan name, specs and the current Rial price. Filter with the query parameters.

Authentication: None, this endpoint is public.

Query parameters

Responses

• 200 OK. Returns: data (list of CustomerPlan), meta (object).

Example

curl -X GET https://veneshcloud.ir/api/catalog/plans \
  -H "Accept: application/json"

Get a plan

GET /catalog/plans/{customerPlan}

Returns one plan.

Authentication: None, this endpoint is public.

Path parameters

Responses

• 200 OK. Returns CustomerPlan.
• 404 Not found

Example

curl -X GET https://veneshcloud.ir/api/catalog/plans/PLAN_ID \
  -H "Accept: application/json"

Current exchange rate

GET /catalog/fx-current

Returns the rate currently used to convert plan prices to Rial.

Authentication: None, this endpoint is public.

Responses

• 200 OK. Returns: usd (string), rial (integer), fx_rate_id (integer), rate (string), effective_rate (string), buffer_percent (string), as_of (string).
• 503 Temporarily unavailable

Example

curl -X GET https://veneshcloud.ir/api/catalog/fx-current \
  -H "Accept: application/json"

List regions

GET /catalog/regions

Returns a provider's regions with their English and Persian names and flag, for region pickers. Public.

Authentication: None, this endpoint is public.

Query parameters

Responses

• 200 OK. Returns: data (list of RegionOption).

Example

curl -X GET https://veneshcloud.ir/api/catalog/regions \
  -H "Accept: application/json"

List optional features

GET /catalog/features

Says whether data disks can be ordered right now and the size limits (min_gb, max_gb, max_per_vm) and the providers that have them. Public.

Authentication: None, this endpoint is public.

Responses

• 200 OK. Returns: data (CatalogFeatures).

Example

curl -X GET https://veneshcloud.ir/api/catalog/features \
  -H "Accept: application/json"

Objects

Field lists for the objects returned above.

CatalogFeatures

CustomerPlan

RegionOption