Coolify Octri Demo
GET/servers/import/check

Check whether a server can be imported

Checks whether this instance can import a server before the source instance starts the transfer. The check covers the token, bundle version, server limit, duplicate server UUID or IP, SSH reachability, and system-wide GitHub and GitLab Apps.

6 parameters
server_uuidstringrequired
The UUID of the server to check for import.
ipstringrequired
The server's IP address.
portintegeroptional
SSH port to check. Defaults to 22 when omitted.
Default:22
schema_versionintegeroptional
Version of the transfer bundle schema to check.
system_github_apps[]array<string>optional
UUIDs of system-wide GitHub Apps used by the server; the response lists any that this instance does not have.
system_gitlab_apps[]array<string>optional
UUIDs of system-wide GitLab Apps used by the server; the response lists any that this instance does not have.

3 status codes
200Returns the result of each check when the server can be imported.
401Returned when the request is unauthenticated.
messagestringoptional
422Returned when one or more checks fail; the response lists the result of each check.

Error handling

A 401 is returned when the request is unauthenticated. A 422 is returned when one or more import checks fail; inspect the check results to identify what needs attention. Supply server_uuid and ip; port defaults to 22 when omitted.