deployment_url

Creates, updates, deletes, gets or lists a deployment_url resource.

Overview

Name	deployment_url
Type	Resource
Id	digitalocean.apps.deployment_url

Fields

The following fields are returned by SELECT queries:

apps_get_exec

A JSON object with a websocket URL that allows sending/receiving console input and output.

Name	Datatype	Description
url	string	A websocket URL that allows sending/receiving console input and receiving console output. (example: wss://exec/?token=xxx)

apps_get_exec_active_deployment

A JSON object with a websocket URL that allows sending/receiving console input and output.

Name	Datatype	Description
url	string	A websocket URL that allows sending/receiving console input and receiving console output. (example: wss://exec/?token=xxx)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
apps_get_exec	select	app_id, deployment_id, component_name	instance_name	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.
apps_get_exec_active_deployment	select	app_id, component_name	instance_name	Returns a websocket URL that allows sending/receiving console input and output to a component of the active deployment if one exists.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
app_id	string	The app ID (example: 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf)
component_name	string	An optional component name. If set, logs will be limited to this component only. (example: component)
deployment_id	string	The deployment ID (example: 3aa4d20e-5527-4c00-b496-601fbd22520a)
instance_name	string	The name of the actively running ephemeral compute instance (example: go-app-d768568df-zz77d)

SELECT examples

apps_get_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.

SELECT
url
FROM digitalocean.apps.deployment_url
WHERE app_id = '{{ app_id }}' -- required
AND deployment_id = '{{ deployment_id }}' -- required
AND component_name = '{{ component_name }}' -- required
AND instance_name = '{{ instance_name }}';

apps_get_exec_active_deployment

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

SELECT
url
FROM digitalocean.apps.deployment_url
WHERE app_id = '{{ app_id }}' -- required
AND component_name = '{{ component_name }}' -- required
AND instance_name = '{{ instance_name }}';