POST

/api/v1/team/hosted/profiles/{id}/start

Start a shared browser on the local team host

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/team/hosted/profiles/{id}/start" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.

Authentication and permissions#

Authentication: Bearer token

Scopes: admin

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

Parameter	Location	Required	Description
`id`	path	Yes

Complete parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "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"
              }
            ]
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

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

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Freigegebenen Browser auf dem lokalen Teamhost starten",
  "tags": [
    "Team"
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "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"
                  }
                ]
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}