Truefoundry Docs

Create or Update Workspace

curl --request PUT \
  --url https://{controlPlaneURL}/api/svc/v1/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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>"
    }
  },
  "dryRun": true
}
'

{
  "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>"
  }
}

PUT

api

svc

workspaces

Create or Update Workspace

curl --request PUT \
  --url https://{controlPlaneURL}/api/svc/v1/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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>"
    }
  },
  "dryRun": true
}
'

{
  "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>"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

manifest

WorkspaceManifest · object

required

Workspace manifest

Show child attributes

manifest.type

enum<string>

required

+value=workspace

Available options:

workspace

manifest.cluster_fqn

string

required

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

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

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.

manifest.labels

object

+sort=700

Show child attributes

manifest.labels.{key}

string

manifest.annotations

object

+sort=750

Show child attributes

manifest.annotations.{key}

string

manifest.collaborators

Collaborator · object[]

+label=Collaborators +sort=500

Show child attributes

manifest.collaborators.subject

string

required

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

manifest.collaborators.role_id

string

required

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

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

manifest.permissions.resource_fqn

string

required

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

manifest.permissions.resource_type

string

required

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

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

manifest.ownedBy

OwnedBy · object

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

Show child attributes

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}

dryRun

boolean

Dry run the request

Response

Creates or updates a workspace with given manifest
- Corresponding authorization entry with admin role is made using newly created workspace
- Attached with the cluster id where the workspace is created

data

Workspace · object

required

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[]

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

List Workspace Get 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

Create or Update Workspace

Authorizations

Body

Response