Give Feedback

pydo.apps.get_exec_active_deployment()

Generated on 7 Jul 2026 from pydo version v0.39.0

Copy page as Markdown View page as Markdown

Usage

client.apps.get_exec_active_deployment(
    app_id="4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
    component_name="component",
    instance_name=None,
)

Returns JSONRaises HttpResponseError

Description

Returns a websocket URL that allows sending/receiving console input and output to a component of the active deployment if one exists.

Parameters

app_id string required: The app ID
component_name string required: An optional component name. If set, logs will be limited to this component only.
instance_name string optional: The name of the actively running ephemeral compute instance

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.apps.get_exec_active_deployment(app_id="a6adf840", component_name="component")

Response Example

Show Response Example

{
  "url": "wss://exec/?token=xxx"
}

More Information

See /v2/apps/{app_id}/components/{component_name}/exec in the API reference for additional detail on responses, headers, parameters, and more.