pydo.apps.get_exec()
Generated on 11 Jul 2025
from pydo version
v0.13.0
Description
Returns a websocket URL that allows sending/receiving console input and output to a component of the specified deployment if one exists. Optionally, the instance_name parameter can be provided to retrieve the exec URL for a specific instance. Note that instances are ephemeral; therefore, we recommended to avoid making persistent changes or such scripting around them.
Parameters
| Name | Type | Required | Description | Default Value |
|---|---|---|---|---|
app_id |
string | True | The app ID | |
deployment_id |
string | True | The deployment ID | |
component_name |
string | True | An optional component name. If set, logs will be limited to this component only. | |
instance_name |
string | False | The name of the actively running ephemeral compute instance |
Request Sample
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
get_resp = client.apps.get_exec(app_id="4f6c71e2", deployment_id="3aa4d20e", component_name="component")More Information
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.