operationId: apps_get_exec
summary: Retrieve Exec URL for Deployment
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.
tags:
- Apps
parameters:
- $ref: parameters.yml#/app_id
- $ref: parameters.yml#/deployment_id
- $ref: parameters.yml#/component
- $ref: parameters.yml#/instance_name
responses:
"200":
$ref: responses/get_exec.yml
"401":
$ref: ../../shared/responses/unauthorized.yml
"404":
$ref: "../../shared/responses/not_found.yml"
"429":
$ref: "../../shared/responses/too_many_requests.yml"
"500":
$ref: ../../shared/responses/server_error.yml
default:
$ref: ../../shared/responses/unexpected_error.yml
x-codeSamples:
- $ref: "examples/curl/apps_get_exec.yml"
- $ref: "examples/python/apps_get_exec.yml"
security:
- bearer_auth:
- "app:access_console"