POST

/api/v1/profiles/{id}/external-links

Open a web link in an existing profile session

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/profiles/{id}/external-links" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: runtime:control

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#

Required.

Field	Type	Required	Description
`session_id`	`string`	Yes
`url`	`string`	Yes

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "session_id",
          "url"
        ],
        "properties": {
          "session_id": {
            "type": "string",
            "maxLength": 128
          },
          "url": {
            "type": "string",
            "maxLength": 8192
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response"
}

This response has no content schema in the export.

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": "Weblink in einer bestehenden Profilsitzung öffnen",
  "tags": [
    "Laufzeit"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "session_id",
            "url"
          ],
          "properties": {
            "session_id": {
              "type": "string",
              "maxLength": 128
            },
            "url": {
              "type": "string",
              "maxLength": 8192
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "runtime:control"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}