Truefoundry Docs

List Workspace

curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/workspaces \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "fqn": "<string>",
      "name": "<string>",
      "tenantName": "<string>",
      "clusterId": "<string>",
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectType": "user",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "manifest": {
        "type": "workspace",
        "cluster_fqn": "<string>",
        "name": "<string>",
        "environment_name": "<string>",
        "labels": {},
        "annotations": {},
        "collaborators": [
          {
            "subject": "<string>",
            "role_id": "<string>"
          }
        ],
        "permissions": [
          {
            "resource_fqn": "<string>",
            "resource_type": "<string>",
            "role_id": "<string>"
          }
        ],
        "ownedBy": {
          "account": "<string>"
        }
      },
      "environmentId": "<string>",
      "accountId": "<string>",
      "isSystemWs": true,
      "createdBy": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

GET

api

svc

workspaces

List Workspace

curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/workspaces \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "fqn": "<string>",
      "name": "<string>",
      "tenantName": "<string>",
      "clusterId": "<string>",
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectType": "user",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "manifest": {
        "type": "workspace",
        "cluster_fqn": "<string>",
        "name": "<string>",
        "environment_name": "<string>",
        "labels": {},
        "annotations": {},
        "collaborators": [
          {
            "subject": "<string>",
            "role_id": "<string>"
          }
        ],
        "permissions": [
          {
            "resource_fqn": "<string>",
            "resource_type": "<string>",
            "role_id": "<string>"
          }
        ],
        "ownedBy": {
          "account": "<string>"
        }
      },
      "environmentId": "<string>",
      "accountId": "<string>",
      "isSystemWs": true,
      "createdBy": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

integer

default:100

Number of items per page

Required range: 1 <= x <= 1000

Example:

10

offset

integer

default:0

Number of items to skip

Required range: x >= 0

Example:

0

clusterId

string

ClusterId of the Cluster

name

string

Workspace Name

fqn

string

Workspace FQN

Response

200 - application/json

Returns all the workspaces associated with a user and also the response includes paginated data.

data

Workspace · object[]

required

Array of Workspace

Show child attributes

data.id

string

required

data.fqn

string

required

data.name

string

required

data.tenantName

string

required

data.clusterId

string

required

data.createdBySubject

Subject · object

required

Show child attributes

data.createdBySubject.subjectId

string

required

Subject ID

data.createdBySubject.subjectType

enum<string>

required

Subject type

Available options:

user,

team,

serviceaccount,

virtualaccount

data.createdBySubject.subjectSlug

string

Subject slug

data.createdBySubject.subjectDisplayName

string

Subject display name

data.createdAt

string<date-time>

required

data.updatedAt

string<date-time>

required

data.manifest

WorkspaceManifest · object

required

Show child attributes

data.manifest.type

enum<string>

required

+value=workspace

Available options:

workspace

data.manifest.cluster_fqn

string

required

+label=Cluster FQN +sort=150 +icon=fa-spider-web:#326ce5 +uiProps={"disableCloudProvider": true}

data.manifest.name

string

required

+label=Name +sort=200 +icon=fa-desktop:#black +message=3 to 32 lower case characters long alphanumeric word, may contain - in between, cannot start with a number

data.manifest.environment_name

string

+label=Environment +sort=300 +icon=fa-tags:#black +usage=Tag the environment like dev, staging or production. You will need to create environments if you don't have already.

data.manifest.labels

object

+sort=700

Show child attributes

data.manifest.labels.{key}

string

data.manifest.annotations

object

+sort=750

Show child attributes

data.manifest.annotations.{key}

string

data.manifest.collaborators

Collaborator · object[]

+label=Collaborators +sort=500

Show child attributes

data.manifest.collaborators.subject

string

required

+label=Subject FQN +usage=Fully Qualified Name of the subject. eg: user:email or team:teamname

data.manifest.collaborators.role_id

string

required

+label=Role ID +usage=Role ID for the resource

data.manifest.permissions

Permissions · object[]

+label=Permissions +sort=500 +uiType=Permissions +uiProps={"allowedResources": {"mlf-project": {"title": "ML Repo", "description": "ML Repos are used to store models and artifacts like git repos. MLRepos are backed by S3 / GCS / Azure bucket and you can have different ml repos with different set of permissions. View Docs"}}}

Show child attributes

data.manifest.permissions.resource_fqn

string

required

+label= Resource FQN +usage=The fully qualified name of the resource

data.manifest.permissions.resource_type

string

required

+label=Resource Type +usage=The type of the resource (cluster, workspace, etc.)

data.manifest.permissions.role_id

string

required

+label=Role ID +usage=The role id of the role to be assigned to the service account for that resource

data.manifest.ownedBy

OwnedBy · object

+label=Owner +usage=Names of the owners that own this resource

Show child attributes

data.manifest.ownedBy.account

string

required

+label=Account Name +sort=1 +usage=The name of the account that owns this resource +placeholder=Search Account +uiType=AccountSelect +uiProps={"maxAllowedAccounts": 1}

data.environmentId

string

data.accountId

string | null

data.isSystemWs

boolean

data.createdBy

string

pagination

Pagination · object

required

Pagination information

Show child attributes

pagination.total

integer

required

Total number of items

Example:

100

pagination.offset

integer

Number of items skipped

Example:

0

pagination.limit

integer

Number of items per page

Example:

10

Delete a JWT for a virtual account Create or Update Workspace

⌘I

TrueFoundry SDK

TrueFoundry ML Client

Apply API Guides

Applications

Apply

Artifacts

Audit Logs

Clusters

Jobs

Logs

MLRepos

Model Deployments

Models

Personal Access Tokens

Prompts

Provider Integrations

Secret Groups

Secrets

Teams

Traces

Users

Virtual Accounts

Workspaces

List Workspace

Authorizations

Query Parameters

Response