Apps

Create an app

Provisions an app synchronously (template repo plus provider project) and responds 201 with the persisted record whether provisioning ends ready or failed; branch on the returned status. Requires an API key whose role includes developer. Pass an idempotencyKey to make retries safe: repeating a create with the same key returns the existing app instead of provisioning a duplicate. Initial environment variables are applied to the provider project before the first deployment. Omit regionPreference to use the default region. Omit domain to put the app's host on the default Khotan-managed namespace; an unavailable domain returns 400 invalid_domain.

post/api/v1/apps

Request

  • Base URL
    https://app.khotan.com
  • URL
    https://app.khotan.com/api/v1/apps
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Request body

namestring required
regionPreferencestring nullable
domainstring nullable

Khotan-managed domain namespace for the app's host, such as khotan.app or apps.khotan.com. Omit to use the default namespace.

idempotencyKeystring

Response

The persisted app record, in ready or failed status.

idstring required
displayNamestring required
slugstring required
providerstring required
source'managed' | 'external' required
status'creating' | 'ready' | 'failed' required
lifecycle'active' | 'suspended' required
regionPreferencestring nullable required
liveUrlstring nullable required
primaryHostnamestring nullable required
envChangedAtstring nullable required
protectedboolean required
tagsstring[] required
createdAtstring required
updatedAtstring required
readyAtstring nullable required
failedAtstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.