KHkhotan
Apps

Link an external app

Registers an existing hosted project (deployed outside Khotan) as an external app so it can be attached to a project. Provide the app name, hosting project id or slug, production URL, GitHub repository URL, and default branch. Linking the same references again returns the existing record.

post/api/v1/apps/external

Request

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

Request body

namestring required
vercelProjectIdstring required
productionUrlstring required
githubRepositoryUrlstring required
defaultBranchstring required

Response

The existing external app matched by its references.

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.