Workspace Management API

Overview

Prerequisites:

This feature is available with the Paradime Enterprise pack.
Your API keys must have either User Management Admin or User Metadata Viewer capabilities.

The examples below authenticate with an account API key — pass Authorization: Bearer <token> (the account key starts with prdm_cmp_). This is an account-wide endpoint, so the X-Paradime-Workspace header is not required. Legacy workspace API keys are still supported: send X-API-KEY and X-API-SECRET headers instead. See API Keys.

The Workspace Management API enables you to view workspace metadata for your Paradime accounts.

List Workspaces

This endpoint will return details on the current active workspaces in your Paradime Account. Example Request

GraphQL
cURL

import requests
import os

# API credentials
api_endpoint = "<YOUR_API_ENDPOINT>"
api_token = "<YOUR_API_TOKEN>"          # account API key (starts with prdm_cmp_)

graphql_query = """
query ListWorkspaces {
    listWorkspaces {
        ok
        workspaces {
            name
            uid
        }
    }
}
  """
  
response = requests.post(api_endpoint, json={"query": graphql_query}, headers={
      "Content-Type": "application/json",
      "Authorization": f"Bearer {api_token}",
  })

print(response.json())

curl -X POST "<YOUR_API_ENDPOINT>" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <YOUR_API_TOKEN>" \
     -d '{
       "query": "query ListWorkspaces { listWorkspaces { ok workspaces { name uid } } }"
     }'

Example response

{
  "data": {
    "listWorkspaces": {
      "ok": true,
      "workspaces": [
        {
          "name": "data-platoform",
          "uid": "r233tak125coyphm"
        },
        {
          "name": "finance",
          "uid": "vxs6x31394cqk2vd"
        },
        {
          "name": "sales",
          "uid": "fuqge1jaj1122i5k"
        }
      ]
    }
  }
}

Git repository connection

Read and set how a workspace connects to its Git repository: through the GitHub App, through a GitLab connection, or with its SSH deploy key.

Your API key needs the Git repository admin capability.
These operations act on one workspace, so an account API key must send the X-Paradime-Workspace: <workspace_uid> header.
The API uses only installations and connections that your company already holds. An API key has no GitHub account of its own.

Read the connection

gitRepository returns the workspace’s connection:

connection.mode: SSH_DEPLOY_KEY, GITHUB_APP, or GITLAB_APP.
connection.installationId, connection.repoId, and connection.repoFullName: the GitHub App installation and the repository it is pinned to.
state: CONNECTED, DEGRADED, or DISCONNECTED.
gitUri: the repository URL.
hasDeployKey: true when a deploy key clone exists to fall back to.
pendingInstallRequests: GitHub App install requests that wait for an organization owner.

query GitRepository {
  gitRepository {
    connection {
      mode
      installationId
      repoId
      repoFullName
    }
    state
    gitUri
    hasDeployKey
  }
}

Set the connection

setGitRepository takes a mode and, for some modes, the repository to connect:

`mode`	Arguments	Result
`GITHUB_APP`	`installationId` and `repoId` (the repository’s numeric GitHub id)	Connects the workspace to that repository through that installation.
`GITHUB_APP`	None	Switches the current repository to the GitHub App, in place.
`GITLAB_APP`	`baseUrl` (the GitLab connection’s base URL) and `projectId` (the project’s numeric GitLab id)	Connects the workspace to that project through that GitLab connection.
`GITLAB_APP`	None	Switches the current repository to the GitLab connection, in place.
`SSH_DEPLOY_KEY`	None	Switches the workspace back to its deploy key.

Pass both arguments of a pair, or neither.

mutation SetGitRepository {
  setGitRepository(mode: GITHUB_APP, installationId: "12345678", repoId: "987654321") {
    ok
    connection {
      mode
      repoFullName
    }
  }
}

API Keys & Access

GraphQL API

Python SDK

Paradime CLI

Webhooks

Virtual Environments

Workspace Management API

Overview

List Workspaces

Git repository connection

Read the connection

Set the connection

​Overview

​List Workspaces

​Git repository connection

​Read the connection

​Set the connection

Overview

List Workspaces

Git repository connection

Read the connection

Set the connection