Activate the Workspace

POST 
/api/workspaces/:id/activate/

Activate the workspace. This sends a signal to scale up the app version runners, making sure that there is an app replica available to process jobs. This method also immediately polls and returns whether the workspace is actively running on cloud.

Request

Path Parameters

id integerrequired

A unique integer value identifying this workspace.

Responses

200

application/json

Schema

Schema

is_active booleanrequired

Shows whether or not the workspace is active.

Example (from schema)

{
  "is_active": true
}

202

Waiting for activation.

401

No authentication found or authentication is not correct.

403

Specified path is not allowed

Permission evaluation:

Is Authenticated AND Is Not App AND Workspace Permission AND Workspace Is Not Public

Descriptions:

Workspace Is Not Public : Checks whether the requested workspace object is not a public workspace.

Is Authenticated : Allows access only to authenticated users.

Workspace Permission : Checks whether the user has access rights to the workspace.

Is Not App : Client must not be a VIKTOR app.

429

Total computation time limit is exceeded

Loading...