GET

/api/v1/team/hosted/profiles

Ausführbare Profile und Sitzungen auf dem Teamhost

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/team/hosted/profiles" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs.

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: admin

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Kontorechte, Anfrageinhalt, Tresorzustand und Ressourcenrechte können weitere Voraussetzungen setzen.

Parameter#

Keine Pfad- oder Query-Parameter deklariert.

Anfragekörper#

Kein Anfragekörper deklariert.

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "enabled",
          "max_sessions",
          "items"
        ],
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "max_sessions": {
            "type": "integer"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "name",
                "session"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "session": {
                  "anyOf": [
                    {
                      "type": "object",
                      "required": [
                        "remote_id",
                        "member_id",
                        "member_name",
                        "state",
                        "browser"
                      ],
                      "properties": {
                        "remote_id": {
                          "type": "string"
                        },
                        "member_id": {
                          "type": "string"
                        },
                        "member_name": {
                          "type": "string"
                        },
                        "state": {
                          "anyOf": [
                            {
                              "type": "string",
                              "enum": [
                                "starting"
                              ]
                            },
                            {
                              "type": "string",
                              "enum": [
                                "running"
                              ]
                            },
                            {
                              "type": "string",
                              "enum": [
                                "stopping"
                              ]
                            }
                          ]
                        },
                        "browser": {
                          "anyOf": [
                            {
                              "type": "object",
                              "required": [
                                "profile_id",
                                "profile_no",
                                "session_id",
                                "pid",
                                "debug_port",
                                "ws_endpoint",
                                "http",
                                "webdriver",
                                "kernel",
                                "relay_port",
                                "exit_ip",
                                "proxy_country",
                                "timezone",
                                "languages",
                                "started_at"
                              ],
                              "properties": {
                                "profile_id": {
                                  "type": "string"
                                },
                                "profile_no": {
                                  "type": "integer"
                                },
                                "session_id": {
                                  "type": "string"
                                },
                                "pid": {
                                  "type": "integer"
                                },
                                "debug_port": {
                                  "type": "integer"
                                },
                                "ws_endpoint": {
                                  "type": "string"
                                },
                                "http": {
                                  "type": "string"
                                },
                                "webdriver": {
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "kernel": {
                                  "type": "object",
                                  "required": [
                                    "engine",
                                    "version",
                                    "build",
                                    "source"
                                  ],
                                  "properties": {
                                    "engine": {
                                      "type": "string"
                                    },
                                    "version": {
                                      "type": "string"
                                    },
                                    "build": {
                                      "type": "string"
                                    },
                                    "source": {
                                      "type": "string"
                                    }
                                  }
                                },
                                "relay_port": {
                                  "type": [
                                    "integer",
                                    "null"
                                  ]
                                },
                                "exit_ip": {
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "proxy_country": {
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "timezone": {
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "languages": {
                                  "type": "array",
                                  "items": {
                                    "type": "string"
                                  }
                                },
                                "started_at": {
                                  "type": "integer"
                                }
                              }
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

default · HTTP-Fehlerhülle. Status und error.code bezeichnen den Fehler.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

Allgemeine Authentifizierungs- und Transportfehler können zusätzlich zu den dokumentierten Antworten auftreten.

OpenAPI-Definition#

Vollständige Operationsdefinition

OpenAPI JSON

{
  "summary": "Ausführbare Profile und Sitzungen auf dem Teamhost",
  "tags": [
    "Team"
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "enabled",
              "max_sessions",
              "items"
            ],
            "properties": {
              "enabled": {
                "type": "boolean"
              },
              "max_sessions": {
                "type": "integer"
              },
              "items": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "session"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "session": {
                      "anyOf": [
                        {
                          "type": "object",
                          "required": [
                            "remote_id",
                            "member_id",
                            "member_name",
                            "state",
                            "browser"
                          ],
                          "properties": {
                            "remote_id": {
                              "type": "string"
                            },
                            "member_id": {
                              "type": "string"
                            },
                            "member_name": {
                              "type": "string"
                            },
                            "state": {
                              "anyOf": [
                                {
                                  "type": "string",
                                  "enum": [
                                    "starting"
                                  ]
                                },
                                {
                                  "type": "string",
                                  "enum": [
                                    "running"
                                  ]
                                },
                                {
                                  "type": "string",
                                  "enum": [
                                    "stopping"
                                  ]
                                }
                              ]
                            },
                            "browser": {
                              "anyOf": [
                                {
                                  "type": "object",
                                  "required": [
                                    "profile_id",
                                    "profile_no",
                                    "session_id",
                                    "pid",
                                    "debug_port",
                                    "ws_endpoint",
                                    "http",
                                    "webdriver",
                                    "kernel",
                                    "relay_port",
                                    "exit_ip",
                                    "proxy_country",
                                    "timezone",
                                    "languages",
                                    "started_at"
                                  ],
                                  "properties": {
                                    "profile_id": {
                                      "type": "string"
                                    },
                                    "profile_no": {
                                      "type": "integer"
                                    },
                                    "session_id": {
                                      "type": "string"
                                    },
                                    "pid": {
                                      "type": "integer"
                                    },
                                    "debug_port": {
                                      "type": "integer"
                                    },
                                    "ws_endpoint": {
                                      "type": "string"
                                    },
                                    "http": {
                                      "type": "string"
                                    },
                                    "webdriver": {
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "kernel": {
                                      "type": "object",
                                      "required": [
                                        "engine",
                                        "version",
                                        "build",
                                        "source"
                                      ],
                                      "properties": {
                                        "engine": {
                                          "type": "string"
                                        },
                                        "version": {
                                          "type": "string"
                                        },
                                        "build": {
                                          "type": "string"
                                        },
                                        "source": {
                                          "type": "string"
                                        }
                                      }
                                    },
                                    "relay_port": {
                                      "type": [
                                        "integer",
                                        "null"
                                      ]
                                    },
                                    "exit_ip": {
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "proxy_country": {
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "timezone": {
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "languages": {
                                      "type": "array",
                                      "items": {
                                        "type": "string"
                                      }
                                    },
                                    "started_at": {
                                      "type": "integer"
                                    }
                                  }
                                },
                                {
                                  "type": "null"
                                }
                              ]
                            }
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}