configurations
Creates, updates, deletes, gets or lists a configurations resource.
Overview​
| Name | configurations |
| Type | Resource |
| Id | ovh.hosting_web.configurations |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Id of the current configuration |
app_env | string | Application environment (development, production) (wire: appEnv) |
entry_point | string | Application launch script (wire: entryPoint) |
language | string | language chosen for the current hosting (nodejs, python, ruby) |
public_dir | string | Directory of the application (wire: publicDir) |
status | string | Status of current configuration (created, creating, deleting, updating) |
version | string | version of the language chosen for the current hosting |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the configuration. Returns the language, version, environment, launch script and public directory of the application. | |
update | update | service_name | Update the configuration. Updates the language, version, environment, launch script or public directory of the application. |
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 |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
service_name | string | The internal name of your hosting (wire: serviceName) |
SELECT examples​
- get
Get the configuration. Returns the language, version, environment, launch script and public directory of the application.
SELECT
id,
app_env,
entry_point,
language,
public_dir,
status,
version
FROM ovh.hosting_web.configurations
WHERE service_name = '{{ service_name }}' -- required
;
UPDATE examples​
- update
Update the configuration. Updates the language, version, environment, launch script or public directory of the application.
UPDATE ovh.hosting_web.configurations
SET
app_env = '{{ app_env }}',
entry_point = '{{ entry_point }}',
language = '{{ language }}',
public_dir = '{{ public_dir }}',
version = '{{ version }}'
WHERE
service_name = '{{ service_name }}' --required;