Catalogue

Every /v1 route for catalogue. This page is generated from the API's OpenAPI contract, so it always matches what the API accepts and returns.

Authentication, pagination, errors and idempotency work the same on every route. They are described once, in the API overview.

Instance tiers, unit rates and free allowances

GET /v1/pricing

Key scopes: READ and PLATFORM_API.

Returns

bash

curl "https://api.naijacloud.com/v1/pricing" \
  -H "Authorization: Bearer $NC_API_KEY"

GET /v1/regions

freeTier says whether the Free size can be placed there; isDefault marks the default.

Key scopes: READ and PLATFORM_API.

Returns

200 with a page: { data: V1DeployLocation[], nextCursor }, where each item is V1DeployLocation.

bash

curl "https://api.naijacloud.com/v1/regions" \
  -H "Authorization: Bearer $NC_API_KEY"

Field	Type	Notes
`freeTier`	`boolean`	Whether a Free-size service can run in this region. Free services run only where the platform's free capacity is; pick a paid size elsewhere.
`isDefault`	`boolean`
`label`	`string`
`region`	`string`

Field	Type	Notes
`computeGraceDays`	`integer`	Days a workspace may sit at an empty balance before its paid apps (web services and cron jobs) are stopped.
`currency`	`string`
`dataGraceDays`	`integer`	Days a workspace may sit at an empty balance before its paid databases and caches are stopped. Their data is kept.
`freeAllowances`	`V1FreeAllowanceCard`
`maxTopUpKobo`	`number`, or `null`	The largest single wallet top-up accepted, in kobo. Null when there is no maximum.
`minTopUpKobo`	`number`	The smallest single wallet top-up accepted, in kobo. Shown on the Add funds sheet before anyone types.
`neverBilled`	array of `string`
`serviceTiers`	array of `V1ServiceTierPrice`
`stopsPaidServices`	`boolean`	Whether an empty balance stops paid apps and databases after the grace periods. False while only preview environments are stopped.
`regionMultipliers`	array of `V1RegionPriceMultiplier`	Price multiplier per region for newly created services.
`topUpBonusCapKobo`	`number`	The most top-up bonus one workspace can receive in any rolling 12 months, in kobo.
`topUpBonusTiers`	array of `V1TopUpBonusTier`	Extra credit on a single large top-up, highest tier first. Credited as its own ledger entry once the payment settles.
`unitRates`	`V1UnitRateCard`
`usdReferenceRate`	`number`	Naira per US dollar used only to convert competitor prices for comparison. Never used to bill.

Field	Type	Notes
`multiplier`	`number`	Applied to app and database prices for services created in this region today. eu-west is the base, 1.0.
`region`	`string`	Region id, e.g. af-west.

Field	Type	Notes
`minTopUpKobo`	`number`	The smallest single top-up that earns this tier, in kobo.
`percent`	`number`	Extra credit, as a percent of what the top-up paid in.

Field	Type	Notes
`currency`	`string`
`dbDiskKoboPerGbMonth`	`number`
`egressKoboPerGb`	`number`
`emailKoboPerMessage`	`number`
`memoryKoboPerGbMonth`	`number`
`objectStorageKoboPerGbMonth`	`number`
`vcpuKoboPerVcpuMonth`	`number`