# Broad Institute Workspaces API

**Canonical:** https://apis.io/apis/broad-institute/broad-institute-workspaces-api/  
**Provider:** Broad Institute — https://apis.io/providers/broad-institute/  
**Base URL:** https://api.firecloud.org  
**Documentation:** https://app.terra.bio

Broad Institute Workspaces API is one of 23 APIs that [Broad Institute](https://apis.io/providers/broad-institute/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Workspace. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Workspaces API from Broad Institute — 20 operation(s) for workspaces.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/workspaces` | Lists workspaces |
| POST | `/api/workspaces` | Create workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}` | Get workspace |
| DELETE | `/api/workspaces/{workspaceNamespace}/{workspaceName}` | Delete workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/accessInstructions` | Get workspace access instructions (if any) |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/acl` | Get workspace ACL |
| PATCH | `/api/workspaces/{workspaceNamespace}/{workspaceName}/acl` | Update workspace ACL |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/bucketOptions` | Get metadata about the workspace bucket |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/checkBucketReadAccess` | Read workspace bucket |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/checkIamActionWithLock/{samActionName}` | Check IAM action with lock |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/clone` | Clone Workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/exportAttributesTSV` | TSV file containing workspace attributes |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/importAttributesTSV` | Import workspace attributes from a tsv file |
| PUT | `/api/workspaces/{workspaceNamespace}/{workspaceName}/lock` | Lock Workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/methodconfigs` | List method configurations in a workspace |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/methodconfigs` | Create a Method Configuration in a workspace |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/permissionReport` | Retrieve user permissions for the workspace and the workspace's method… |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/sendChangeNotification` | Sends notifications for change to workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/tags` | Get the tags for this workspace |
| PUT | `/api/workspaces/{workspaceNamespace}/{workspaceName}/tags` | Replace all tags for this workspace with the user input |
| DELETE | `/api/workspaces/{workspaceNamespace}/{workspaceName}/tags` | Remove the user-supplied tags from the workspace |
| PATCH | `/api/workspaces/{workspaceNamespace}/{workspaceName}/tags` | Add tags to the workspace without modifying pre-existing tags |
| PUT | `/api/workspaces/{workspaceNamespace}/{workspaceName}/unlock` | Unlock Workspace |
| PATCH | `/api/workspaces/{workspaceNamespace}/{workspaceName}/updateAttributes` | Modify attributes on a workspace |
| PATCH | `/api/workspaces/{workspaceNamespace}/{workspaceName}/setAttributes` | Set attributes on a workspace |
| GET | `/api/workspaces/tags` | Get all workspace tags (for autocomplete) |
| GET | `/cookie-authed/workspaces/{workspaceNamespace}/{workspaceName}/exportAttributesTSV` | TSV file containing workspace attributes (allows cookie-based authentication) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/broad-institute/openapi/broad-institute-workspaces-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-workflow-description-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-workspace-details-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-submission-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-submission-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-tool-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-configuration-response-schema.json

## Other Broad Institute APIs (12)

- [Broad Institute Billing V2 API](https://apis.io/apis/broad-institute/broad-institute-billingv2-api/)
- [Broad Institute CromIAM Engine (for Job Manager) API](https://apis.io/apis/broad-institute/broad-institute-cromiam-engine-for-job-manager-api/)
- [Broad Institute CromIAM Workflows (for Admin) API](https://apis.io/apis/broad-institute/broad-institute-cromiam-workflows-for-admin-api/)
- [Broad Institute CromIAM Workflows (for Job Manager) API](https://apis.io/apis/broad-institute/broad-institute-cromiam-workflows-for-job-manager-api/)
- [Broad Institute Entities API](https://apis.io/apis/broad-institute/broad-institute-entities-api/)
- [Broad Institute GA4GH Tool Registry API](https://apis.io/apis/broad-institute/broad-institute-ga4gh-tool-registry-api/)
- [Broad Institute Groups API](https://apis.io/apis/broad-institute/broad-institute-groups-api/)
- [Broad Institute Method Configurations API](https://apis.io/apis/broad-institute/broad-institute-method-configurations-api/)
- [Broad Institute Method Repository API](https://apis.io/apis/broad-institute/broad-institute-method-repository-api/)
- [Broad Institute NIH API](https://apis.io/apis/broad-institute/broad-institute-nih-api/)
- [Broad Institute Notifications API](https://apis.io/apis/broad-institute/broad-institute-notifications-api/)
- [Broad Institute OAuth API](https://apis.io/apis/broad-institute/broad-institute-oauth-api/)

## Tags

Workspace

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/broad-institute/broad-institute-workspaces-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/broad-institute/.