For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.apps.get_exec(
    app_id="4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
    deployment_id="3aa4d20e-5527-4c00-b496-601fbd22520a",
    component_name="component",
    instance_name=None,
)

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

app_id string required

The app ID

deployment_id string required

The deployment 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

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")

Response Example

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

More Information

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