apps

Creates, updates, deletes, gets or lists an apps resource.

Overview

Name	apps
Type	Resource
Id	digitalocean.addons.apps

Fields

The following fields are returned by SELECT queries:

addons_get_app_metadata

The response will be a JSON object with a key called metadata. metadata will be an array of objects, each representing a metadata item for the app. Each object will contain details such as id, name, display_name, description, type, and options. For additional details specific to the app, find and view its DigitalOcean Marketplace page.

Name	Datatype	Description
id	integer	Unique identifier for the addon metadata item. (title: id)
name	string	The name of the metadata item. (title: name, example: country_of_origin)
display_name	string	The display name of the metadata item. (title: display_name, example: Country of Origin)
description	string	A brief description of the metadata item. (title: description, example: Country for localization)
options	array	(title: options)
type	string	The data type of the metadata value. (string, boolean) (title: type, example: string)

addons_get_app

The response will be a JSON object with a key called apps. apps will be an array of objects.

Name	Datatype	Description
app_slug	string	The slug identifier for the application associated with the resource. (title: app_slug, example: example-app)
eula	string	The End User License Agreement URL for the resource. (title: eula, example: https://example.com/eula)
plans	array	A list of plans available for the resource. (title: plans)
tos	string	The Terms of Service URL for the resource. (title: tos, example: https://example.com/tos)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
addons_get_app_metadata	select	app_slug		To find out what metadata is required for a specific add-on, send a GET request to /v2/add-ons/apps/{app_slug}/metadata. Metadata varies by application.
addons_get_app	select			To fetch details of all available Add-On Applications, send a GET request to /v2/add-ons/apps.

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_slug	string	The slug identifier for the application whose metadata is being requested. (example: example_app)

SELECT examples

addons_get_app_metadata

To find out what metadata is required for a specific add-on, send a GET request to /v2/add-ons/apps/{app_slug}/metadata.
Metadata varies by application.

SELECT
id,
name,
display_name,
description,
options,
type
FROM digitalocean.addons.apps
WHERE app_slug = '{{ app_slug }}' -- required
;

addons_get_app

To fetch details of all available Add-On Applications, send a GET request to /v2/add-ons/apps.

SELECT
app_slug,
eula,
plans,
tos
FROM digitalocean.addons.apps
;