Skip to main content
GET
/
preview
/
v2
/
workspaces
/
{workspace}
Get workspace
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/workspaces/{workspace} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "resource_path": "<string>",
  "owner": "<string>",
  "name": "<string>",
  "object": "workspace",
  "created_at": 1738972800
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Path Parameters

​
workspace
string
required

Workspace name or ID A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: (wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1})
Example:

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

Response

Workspace details.

​
id
string
required
Pattern: wksp_[0-9a-zA-Z_-]{1,21}
Example:

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

​
resource_path
string
required

A resource path for a workspace resource. Format: sfc:workspace::.

Pattern: sfc:workspace:([a-zA-Z0-9._-]+:){1}[a-zA-Z0-9._-]+
Example:

"sfc:workspace:<account_id>:<name>"

​
owner
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
name
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
object
string
default:workspace
required
read-only
Allowed value: "workspace"
​
created_at
integer<int64>
required

Unix timestamp.

Example:

1738972800