POST/servers/{uuid}/validate

Validate

Validate server by UUID. With install=true, needs a token with the write and deploy permissions.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
uuidstringrequired
Server UUID
installbooleanoptional
Install missing prerequisites and Docker, then start the proxy. This can restart the Docker daemon. Needs the deploy permission.
Default:false

6 status codes
201Server validation started.
messagestringoptional
400Invalid token.
messagestringoptional
401Unauthenticated.
messagestringoptional
403The token needs the deploy permission to install the server.
404Resource not found.
messagestringoptional
422Validation error.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned: Invalid token. A 401 is returned: Unauthenticated. A 403 is returned: The token needs the deploy permission to install the server. A 404 is returned: Resource not found. A 422 is returned: Validation error.