Pipelines

Create a pipeline

Provisions a pipeline 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 pipeline instead of provisioning a duplicate. Initial environment variables are applied to the provider project before the first run. Omit regionPreference to use the default region.

post/api/v1/pipelines

Request

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

Request body

namestring required
regionPreferencestring nullable
idempotencyKeystring

Response

The persisted pipeline record, in ready or failed status.

idstring required
displayNamestring required
slugstring required
providerstring required
status'creating' | 'ready' | 'failed' required
lifecycle'active' | 'suspended' required
regionPreferencestring nullable required
runtimestring 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.