applications
Creates, updates, deletes, gets or lists an applications resource.
Overview
| Name | applications |
| Type | Resource |
| Id | digitalocean.oneclick.applications |
Fields
The following fields are returned by SELECT queries:
- one_clicks_list
A JSON object with a key of 1_clicks.
| Name | Datatype | Description |
|---|---|---|
slug | string | The slug identifier for the 1-Click application. (title: slug, example: monitoring) |
type | string | The type of the 1-Click application. (title: type, example: kubernetes) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
one_clicks_list | select | type | To list all available 1-Click applications, send a GET request to /v2/1-clicks. The type maybe provided as query paramater in order to restrict results to a certain type of 1-Click, for example: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet.The response will be a JSON object with a key called 1_clicks. This will be set to an array of1-Click application data, each of which will contain the the slug and type for the 1-Click. | |
one_clicks_install_kubernetes | insert | data__addon_slugs, data__cluster_uuid | To install a Kubernetes 1-Click application on a cluster, send a POST request to/v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as bodyparameter in order to specify which 1-Click application(s) to install. To list all available 1-Click Kubernetes applications, send a request to /v2/1-clicks?type=kubernetes. |
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 |
|---|---|---|
type | string | Restrict results to a certain type of 1-Click. (example: kubernetes) |
SELECT examples
- one_clicks_list
To list all available 1-Click applications, send a GET request to /v2/1-clicks. The type may
be provided as query paramater in order to restrict results to a certain type of 1-Click, for
example: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet.
The response will be a JSON object with a key called 1_clicks. This will be set to an array of
1-Click application data, each of which will contain the the slug and type for the 1-Click.
SELECT
slug,
type
FROM digitalocean.oneclick.applications
WHERE type = '{{ type }}'
;
INSERT examples
- one_clicks_install_kubernetes
- Manifest
To install a Kubernetes 1-Click application on a cluster, send a POST request to/v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as body
parameter in order to specify which 1-Click application(s) to install. To list all available
1-Click Kubernetes applications, send a request to /v2/1-clicks?type=kubernetes.
INSERT INTO digitalocean.oneclick.applications (
data__addon_slugs,
data__cluster_uuid
)
SELECT
'{{ addon_slugs }}' /* required */,
'{{ cluster_uuid }}' /* required */
RETURNING
message
;
# Description fields are for documentation purposes
- name: applications
props:
- name: addon_slugs
value: array
description: >
An array of 1-Click Application slugs to be installed to the Kubernetes cluster.
default:
- name: cluster_uuid
value: string
description: >
A unique ID for the Kubernetes cluster to which the 1-Click Applications will be installed.