Nuon.Api.Apps (nuon v0.19.109)
API calls for all endpoints tagged Apps
.
Summary
Functions
Create an app config, by pushing the contents of a config file. The API will automatically configure the app according to the config file in the background.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_input_config_request
(ServiceCreateAppInputConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppInputConfig.t}
on success{:error, Tesla.Env.t}
on failure
create an app runner config
create an app sandbox config
create an app secret
Create an app secret that can be used to configure components. To reference an app secret, use .nuon.secrets.<secret_name>
. NOTE secrets can only be written, or deleted, not read.
delete an app
delete an app secret Delete an app secret.
get an app
get an app config Fetch an app config by id.
get an app config template Create an application template which provides a fully rendered config that can be modified and used to kickstart any application.
get app configs Returns all configs for the app.
get app input configs
get latest app input config
get latest app config Returns the most recent config for the provided app.
get app runner configs
get latest app runner config
get app sandbox configs
get latest app sandbox config
get app secrets List all secrets for an app. NOTE this does not return any sensitive values, as secrets are write only.
get all apps for the current org
Functions
create_app(connection, service_create_app_request, opts \\ [])
@spec create_app( Tesla.Env.client(), Nuon.Model.ServiceCreateAppRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppApp.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create an app
Parameters
connection
(Nuon.Connection): Connection to serverservice_create_app_request
(ServiceCreateAppRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppApp.t}
on success{:error, Tesla.Env.t}
on failure
create_app_config(connection, app_id, service_create_app_config_request, opts \\ [])
@spec create_app_config( Tesla.Env.client(), String.t(), Nuon.Model.ServiceCreateAppConfigRequest.t(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppAppConfig.t()} | {:error, Tesla.Env.t()}
Create an app config, by pushing the contents of a config file. The API will automatically configure the app according to the config file in the background.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_config_request
(ServiceCreateAppConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppConfig.t}
on success{:error, Tesla.Env.t}
on failure
create_app_input_config(connection, app_id, service_create_app_input_config_request, opts \\ [])
@spec create_app_input_config( Tesla.Env.client(), String.t(), Nuon.Model.ServiceCreateAppInputConfigRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppAppInputConfig.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_input_config_request
(ServiceCreateAppInputConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppInputConfig.t}
on success{:error, Tesla.Env.t}
on failure
create_app_runner_config(connection, app_id, service_create_app_runner_config_request, opts \\ [])
@spec create_app_runner_config( Tesla.Env.client(), String.t(), Nuon.Model.ServiceCreateAppRunnerConfigRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppAppRunnerConfig.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create an app runner config
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_runner_config_request
(ServiceCreateAppRunnerConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppRunnerConfig.t}
on success{:error, Tesla.Env.t}
on failure
create_app_sandbox_config(connection, app_id, service_create_app_sandbox_config_request, opts \\ [])
@spec create_app_sandbox_config( Tesla.Env.client(), String.t(), Nuon.Model.ServiceCreateAppSandboxConfigRequest.t(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppAppSandboxConfig.t()} | {:error, Tesla.Env.t()}
create an app sandbox config
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_sandbox_config_request
(ServiceCreateAppSandboxConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppSandboxConfig.t}
on success{:error, Tesla.Env.t}
on failure
create_app_secret(connection, app_id, service_create_app_secret_request, opts \\ [])
@spec create_app_secret( Tesla.Env.client(), String.t(), Nuon.Model.ServiceCreateAppSecretRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppAppSecret.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create an app secret
Create an app secret that can be used to configure components. To reference an app secret, use .nuon.secrets.<secret_name>
. NOTE secrets can only be written, or deleted, not read.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_secret_request
(ServiceCreateAppSecretRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppSecret.t}
on success{:error, Tesla.Env.t}
on failure
delete_app(connection, app_id, opts \\ [])
@spec delete_app(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, boolean()} | {:error, Tesla.Env.t()}
delete an app
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, boolean()}
on success{:error, Tesla.Env.t}
on failure
delete_app_secret(connection, app_id, secret_id, opts \\ [])
@spec delete_app_secret(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, boolean()} | {:error, Tesla.Env.t()}
delete an app secret Delete an app secret.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDsecret_id
(String.t): secret IDopts
(keyword): Optional parameters
Returns
{:ok, boolean()}
on success{:error, Tesla.Env.t}
on failure
get_app(connection, app_id, opts \\ [])
@spec get_app(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.AppApp.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get an app
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppApp.t}
on success{:error, Tesla.Env.t}
on failure
get_app_config(connection, app_id, app_config_id, opts \\ [])
@spec get_app_config(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppAppConfig.t()} | {:error, Tesla.Env.t()}
get an app config Fetch an app config by id.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDapp_config_id
(String.t): app config IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppConfig.t}
on success{:error, Tesla.Env.t}
on failure
get_app_config_template(connection, app_id, type, opts \\ [])
@spec get_app_config_template(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.ServiceAppConfigTemplate.t()} | {:error, Tesla.Env.t()}
get an app config template Create an application template which provides a fully rendered config that can be modified and used to kickstart any application.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDtype
(String.t): app template typeopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.ServiceAppConfigTemplate.t}
on success{:error, Tesla.Env.t}
on failure
get_app_configs(connection, app_id, opts \\ [])
@spec get_app_configs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [Nuon.Model.AppAppConfig.t()]} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get app configs Returns all configs for the app.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppAppConfig{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_app_input_configs(connection, app_id, opts \\ [])
@spec get_app_input_configs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [Nuon.Model.AppAppInputConfig.t()]} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get app input configs
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppAppInputConfig{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_app_input_latest_config(connection, app_id, opts \\ [])
@spec get_app_input_latest_config(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.AppAppInputConfig.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get latest app input config
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppInputConfig.t}
on success{:error, Tesla.Env.t}
on failure
get_app_latest_config(connection, app_id, opts \\ [])
@spec get_app_latest_config(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppAppConfig.t()} | {:error, Tesla.Env.t()}
get latest app config Returns the most recent config for the provided app.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppConfig.t}
on success{:error, Tesla.Env.t}
on failure
get_app_runner_configs(connection, app_id, opts \\ [])
@spec get_app_runner_configs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppAppRunnerConfig.t()]} | {:error, Tesla.Env.t()}
get app runner configs
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppAppRunnerConfig{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_app_runner_latest_config(connection, app_id, opts \\ [])
@spec get_app_runner_latest_config(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.AppAppRunnerConfig.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get latest app runner config
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppRunnerConfig.t}
on success{:error, Tesla.Env.t}
on failure
get_app_sandbox_configs(connection, app_id, opts \\ [])
@spec get_app_sandbox_configs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppAppSandboxConfig.t()]} | {:error, Tesla.Env.t()}
get app sandbox configs
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppAppSandboxConfig{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_app_sandbox_latest_config(connection, app_id, opts \\ [])
@spec get_app_sandbox_latest_config(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppAppSandboxConfig.t()} | {:error, Tesla.Env.t()}
get latest app sandbox config
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppAppSandboxConfig.t}
on success{:error, Tesla.Env.t}
on failure
get_app_secrets(connection, app_id, opts \\ [])
@spec get_app_secrets(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppAppSecret.t()]} | {:error, Tesla.Env.t()}
get app secrets List all secrets for an app. NOTE this does not return any sensitive values, as secrets are write only.
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppAppSecret{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_apps(connection, opts \\ [])
@spec get_apps( Tesla.Env.client(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppApp.t()]} | {:error, Tesla.Env.t()}
get all apps for the current org
Parameters
connection
(Nuon.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, [%AppApp{}, ...]}
on success{:error, Tesla.Env.t}
on failure
update_app(connection, app_id, service_update_app_request, opts \\ [])
@spec update_app( Tesla.Env.client(), String.t(), Nuon.Model.ServiceUpdateAppRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppApp.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
update an app
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDservice_update_app_request
(ServiceUpdateAppRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppApp.t}
on success{:error, Tesla.Env.t}
on failure