Check the Lock Status of a Workspace

API Endpoint: check_workspace_lock

Checks the Lock status of a workspace

Important

An API Key is required for ALL private workspace activities

The API Key name component can be added to your header using any of the following ways, “X-CKAN-API-Key”, “EDX-API-Key”, or “Authorization”.

Attention

Add the "User-Agent": parameter within the headers of the API request
Set "User-Agent": to the value "EDX-USER"

Workspace Lock Key Features

A workspace can be lock and unlocked within the EDX UI and via API script

Locking a Workspace

ONLY the following roles can lock a workspace

System Administrator
Workspace Administrator

Unlocking a Workspace

ONLY the following roles can unlock a workspace

System Administrator
Workspace Administrator who locked the workspace

Feature Functionaility in a Locked Workspace

When a user locks a workspace, functionality within the workspace is limited
The user who locks the workspace will have no restrictions of features within a workspace

Note

If the Lock Restriction field in the tables below are True, the feature is restricted when a workspace is locked

Parameters for Workspace Lock

Feature Name	Lock Restriction
`Delete Resource`	True
`Upload Resource`	True
`Edit Resource Metadata`	True
`Edit Resource License Type`	True
`Add Resource to Cart`	True
`View Resource`	False
`Download Resource`	False
`Rate Resource`	False
`Delete Resource from Recycle Bin`	True
`Recover Resource from Recycle Bin`	True
`Undo Last Action`	True
`Redo Last Action`	True
`Create Folder`	True
`Move Folder`	True
`Delete Folder`	True
`Rename Folder`	True

Feature Name	Lock Restriction
`Create Submission`	True
`View Submission`	False
`View JSON Metadata`	False
`Edit Submission`	True
`Add Resource`	True
`Follow`	False
`Push to Public`	True
`Apply for DOI and Push to Public`	True
`Edit Resources`	True
`Add Resource`	True
`Delete Resource`	True
`Change Resource License`	True
`Update Resource`	True

Feature Name	Lock Restriction
`Create Submission`	True
`Download Selected`	False
`Remove Selected`	False
`Clear Cart`	False
`View Resource`	False
`Rate Resource`	False
`Edit Resource`	True
`Add Resource`	True
`Edit Resource Metadata`	True
`Edit License Type`	True

Parameter Definitions

Parameter Name	Description	Required Fields
`workspace_id`	ID associated with the workspace	Required
`EDX-API-KEY`	API key associated with the the user	Required
`is_locked`	Boolean grabbed from database table to identify if workspace is locked	N/A

Example: Check the Lock Status of a Workspace

Attention

Add the "User-Agent": parameter within the headers of the API request
Set "User-Agent": to the value "EDX-USER"

Note

The is_locked output parameter’s value is gathered from the workspace lock database table

If is_locked value is True, the workspace is locked
If is_locked value is False, the workspace is unlocked

python
Workspace Status Locked
Workspace Status Unlocked

import requests

headers = {
    'EDX-API-Key': 'INSERT-API-KEY-HERE',
    'User-Agent': 'EDX-USER',
    'Content-Type': 'application/json',
    'Accept':'application/json'
}

data = {
    'workspace_id': 'workspace-id-or-url-name'
}

url = 'https://edx.netl.doe.gov/api/3/action/check_workspace_lock'
r = requests.post(
url, # URL to API endpoint
headers=headers, # Headers dictionary
json=data, # Dictionary of data params

)
r_json = r.json()
print (r.json())

{'help': '/api/3/action/help_show?name=check_workspace_lock', 'success': True,
'result': {'is_locked': True, 'locked_by': 'EDX Administrator (edxadministrator@edx.com)', 'date_locked': '2025-05-12 12:32'}}

{'help': '/api/3/action/help_show?name=check_workspace_lock', 'success': True,
'result': {'is_locked': False, 'unlocked_by': 'EDX Administrator (edxadministrator@edx.com)', 'date_unlocked': '2025-05-12 12:32'}}