GET /v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec
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.
Servers
- https://api.digitalocean.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
deployment_id |
String | Yes |
The deployment ID |
component_name |
String | Yes |
An optional component name. If set, logs will be limited to this component only. |
app_id |
String | Yes |
The app ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
instance_name |
String | No |
The name of the actively running ephemeral compute instance |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.