Unregister a workspace

Unregisters a workspace. Its past runs are kept in the history. Project files are never touched; with purge: true the folder’s .cliq/ directory is deleted too.

When the daemon is connected to CliqHub it also asks CliqHub to drop the workspace from its catalog (hub_removed); if CliqHub cannot be reached the workspace is still unregistered here. Unregistering a path that is not registered succeeds with removed: false.

From the CLI: cliq workspace delete.

No credential is needed from this machine. From another host, send Authorization: Bearer with a dispatch token CliqHub signed for this daemon or a cliq_tok_… personal token of a user in the daemon’s realm; this only works once the daemon is connected to CliqHub. See Authentication.

POST /v1/workspaces/remove

cURL

default

curl --request POST \ --url http://127.0.0.1:4900/v1/workspaces/remove \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "workspace_dir": "/home/dev/acme-api" } '

200

Example

{ "ok": true, "data": { "workspace_dir": "/home/dev/acme-api", "removed": true, "deleted_cliq": false, "hub_removed": true } }

Authorizations

Authorization · string · header · required

Not needed from the same machine. From another host: a dispatch JWT CliqHub signed for this daemon, or a cliq_tok_… personal token whose user is in the daemon's realm.

Body

application/json

workspace_dir · string · required

Absolute workspace path

Minimum string length: 1

purge · boolean

Also delete the folder's .cliq/ directory. Project files are never touched. Default false.

Response

200

application/json

Success.

ok · boolean · required

data · object · required

Show child attributes