Workspace abrufen

GET

workspaces

{workspaceId}

Workspace abrufen

curl --request GET \
  --url https://api.squarecloud.app/v2/workspaces/{workspaceId} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/workspaces/{workspaceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces/{workspaceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/workspaces/{workspaceId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces/{workspaceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "id": "3f9c2a7e5b1d4e8a9c6f0b2d4e6a8c1f",
    "name": "Test",
    "owner": "5354d9742d889d49b20134ba0be09ccc0033be68",
    "members": [
      {
        "name": "Example",
        "id": "5354d9742d889d49b20134ba0be09ccc0033be68",
        "group": "owner",
        "joinedAt": "2025-06-04T20:44:55.934Z"
      }
    ],
    "applications": [],
    "createdAt": "2025-06-04T20:44:55.934Z"
  }
}

string

erforderlich

Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.

Erfordert einen API-Schlüssel mit dem Scope workspaces:manage. Gibt die vollständigen Details eines einzelnen Workspace zurück: Eigentümer, Mitgliederliste mit Rollen, geteilte Anwendungen und Erstellungsdatum. Der authentifizierte Benutzer muss der Eigentümer oder ein aktuelles Mitglied sein; alle anderen, auch mit bloßer Kenntnis der Workspace-ID, erhalten einen 404 statt eines Berechtigungsfehlers, sodass der Endpoint zugleich als einfache Existenzprüfung dient. Verwende diesen Endpoint nach Mitglied einladen oder Anwendung hinzufügen, um zu bestätigen, dass die Änderung übernommen wurde, oder Workspaces auflisten, um alle Workspaces abzurufen, auf die der Aufrufer Zugriff hat. Begrenzt auf 30 Anfragen pro 60 Sekunden pro Benutzer, mit einer kurzen Sperre bei Überschreitung.

Parameter

string

erforderlich

Die ID des Workspace.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.

object

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

string

Die ID des Workspace: 32 hexadezimale Zeichen (eine UUID v4 ohne Bindestriche). Ältere Workspaces haben eine 40-stellige hexadezimale ID.

string

Die ID des Workspace-Eigentümers.

string

Der Name des Workspace.

object

Die Mitgliederliste des Workspace. Sie enthält immer den Eigentümer, mit group: "owner".

Anzeigen Objekt umschalten

string

Die ID des Benutzers.

string

Der Name des Benutzers. Kann null sein, zum Beispiel wenn das Konto gelöscht wurde.

string

Die Berechtigungen des Mitglieds für die Anwendungen des Workspace.

string

Der Zeitstempel des Beitritts in UTC-0.

object

Die Anwendungsliste des Workspace.

Anzeigen Objekt umschalten

string

Die ID der hochgeladenen Anwendung.

string

Der Name der hochgeladenen Anwendung.

number

Die RAM-Nutzung der hochgeladenen Anwendung in MB.

object

Die Programmiersprache der hochgeladenen Anwendung.

string

Der Erstellungszeitstempel in UTC-0.

{
  "status": "success",
  "response": {
    "id": "3f9c2a7e5b1d4e8a9c6f0b2d4e6a8c1f",
    "name": "Test",
    "owner": "5354d9742d889d49b20134ba0be09ccc0033be68",
    "members": [
      {
        "name": "Example",
        "id": "5354d9742d889d49b20134ba0be09ccc0033be68",
        "group": "owner",
        "joinedAt": "2025-06-04T20:44:55.934Z"
      }
    ],
    "applications": [],
    "createdAt": "2025-06-04T20:44:55.934Z"
  }
}

Häufige Fehler

Code	HTTP	Bedeutung
`WORKSPACE_NOT_FOUND`	404	Der Workspace existiert nicht, oder der Aufrufer ist weder Eigentümer noch Mitglied.
`DATABASE_UNAVAILABLE`	503	Der Dienst ist kurzzeitig nicht verfügbar. Versuche es in einigen Sekunden erneut.

Siehe auch

CLI: squarecloud workspace info
SDKs: api.workspaces.get() (JavaScript), client.workspaces.get() (Python), c.Workspaces.Get() (Go)

Workspace abrufen

curl --request GET \
  --url https://api.squarecloud.app/v2/workspaces/{workspaceId} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/workspaces/{workspaceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces/{workspaceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/workspaces/{workspaceId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces/{workspaceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "id": "3f9c2a7e5b1d4e8a9c6f0b2d4e6a8c1f",
    "name": "Test",
    "owner": "5354d9742d889d49b20134ba0be09ccc0033be68",
    "members": [
      {
        "name": "Example",
        "id": "5354d9742d889d49b20134ba0be09ccc0033be68",
        "group": "owner",
        "joinedAt": "2025-06-04T20:44:55.934Z"
      }
    ],
    "applications": [],
    "createdAt": "2025-06-04T20:44:55.934Z"
  }
}

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Parameter

Antwort

Häufige Fehler

Siehe auch

​Parameter

​Antwort

​Häufige Fehler

​Siehe auch

Parameter

Antwort

Häufige Fehler

Siehe auch