Imports

Create an import plan

post/imports/plan

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/imports/plan
  • Auth: HTTP bearer

Request body

repository_idinteger nullable

Optional repository ID to associate with the import If provided, preset will be detected from the repository

source'docker' | 'coolify' | 'dokploy' | 'vercel' | 'netlify' | 'railway' | 'render' | 'fly' | 'kubernetes' | 'caprover' | 'portainer' | 'kamal' | 'custom' required

Import source identifier

workload_idstring required

Unique identifier for a workload in the source system

Response

Import plan created

can_executeboolean required

Whether the plan can be executed

session_idstring required

Session ID for tracking

Changes

No recorded changes to this operation across all 53 revisions of this API.