apps_v2

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

Overview

Name	apps_v2
Type	Resource
Id	sumologic.apps.apps_v2

Fields

The following fields are returned by SELECT queries:

get

Information about the requested app.

Name	Datatype	Description
base_url	string (url)	URL prefix for where the app is stored. (example: https:​//some_bucket.s3.amazonaws.com/path/to/app/version/) (wire: baseUrl)
config	string (byte)	Content of the config YAML file, as Base64-encoded string.
files	object	Content of various files part of app package, as Base64-encoded string.
manifest	string (byte)	Content of the manifest YAML file, as Base64-encoded string.
readme	string (byte)	Content of the README markdown file, as Base64-encoded string.
uuid	string (uuid)	UUID of the app. (example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5)
version	string	Version of the app. (example: 1.0.0)

list

List of apps.

Name	Datatype	Description
name	string	Name of the app. (example: AWS CloudTrail)
account_types	array	Account types of which the app is available to. (wire: accountTypes)
attributes	object	A map of attributes for this app. Attributes allow to group apps based on different criteria.
author	string	Author of the app. (example: Sumo Logic)
beta	boolean	Whether the app is in beta.
description	string	Description of the app. (example: AWS CloudTrail app description)
icon	string	URL of the icon for the app. (example: https:​//some-bucket.s3.amazonaws.com/AWSCloudTrail.png)
installable	boolean	Whether the app is installable or not as not all apps are installable.
installs	integer (int32)	Number of times the app was installed.
latest_version	string	Latest version of the app. (example: 1.1.0) (wire: latestVersion)
modified_at	string (date-time)	The timestamp in UTC of the most recent modification of the app. (example: 2018-10-16T09:10:00.000Z) (wire: modifiedAt)
show_on_marketplace	boolean	Whether the app should show up on sumologic.com/applications webpage. (wire: showOnMarketplace)
uuid	string	UUID of the app. (example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	uuid, region	version	Get details about an app with the given UUID and version. The details include:<br /><br /> 1. The base URL for all the resource for the app.<br /> 2. The app manifest
list	select	region	name, author	List all apps from the App Catalog.
install	exec	uuid, region		Schedule an asynchronous job to install the app with the given UUID and version from the App Catalog. The app will be installed in 'Installed Apps' folder in the Content Library.<br /><br />You get back an identifier of asynchronous job in response to this endpoint. You can then use the app install status API to get the status of the installation request. See Asynchronous-Request section for more details on how to work with asynchronous request.
uninstall	exec	uuid, region		Schedule an asynchronous job to uninstall app with the given UUID.<br /><br />You get back an identifier of asynchronous job in response to this endpoint. You can then use the app uninstall status API to get the status of the uninstallation request. See Asynchronous-Request section for more details on how to work with asynchronous request.
upgrade	exec	uuid, region		Schedule an asynchronous job to upgrade the app with the given UUID and version from the App Catalog. The app will be installed in 'Installed Apps' folder in the Content Library.<br /><br />You get back an identifier of asynchronous job in response to this endpoint. You can then use the app upgrade status API to get the status of the upgrade request. See Asynchronous-Request section for more details on how to work with asynchronous request.

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
region	string	Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)
uuid	string	UUID of the app to upgrade. (example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5)
author	string	Author of the app. (example: Sumo%20Logic)
name	string	Name of the app. (example: AWS%20CloudTrail)
version	string	Version of the app. The latest version is used if this is omitted or specified as "latest". (example: 1.0.0)

SELECT examples

get

Get details about an app with the given UUID and version. The details include:<br /><br /> 1. The base URL for all the resource for the app.<br /> 2. The app manifest

SELECT
base_url,
config,
files,
manifest,
readme,
uuid,
version
FROM sumologic.apps.apps_v2
WHERE uuid = '{{ uuid }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
AND version = '{{ version }}'
;

list

List all apps from the App Catalog.

SELECT
name,
account_types,
attributes,
author,
beta,
description,
icon,
installable,
installs,
latest_version,
modified_at,
show_on_marketplace,
uuid
FROM sumologic.apps.apps_v2
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
AND name = '{{ name }}'
AND author = '{{ author }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

install

Schedule an asynchronous job to install the app with the given UUID and version from the App Catalog. The app will be installed in 'Installed Apps' folder in the Content Library.<br /><br />You get back an identifier of asynchronous job in response to this endpoint. You can then use the app install status API to get the status of the installation request. See Asynchronous-Request section for more details on how to work with asynchronous request.

EXEC sumologic.apps.apps_v2.install 
@uuid='{{ uuid }}' --required, 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set 
@@json=
'{
"version": "{{ version }}", 
"parameters": "{{ parameters }}"
}'
;

uninstall

Schedule an asynchronous job to uninstall app with the given UUID.<br /><br />You get back an identifier of asynchronous job in response to this endpoint. You can then use the app uninstall status API to get the status of the uninstallation request. See Asynchronous-Request section for more details on how to work with asynchronous request.

EXEC sumologic.apps.apps_v2.uninstall 
@uuid='{{ uuid }}' --required, 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;

upgrade

Schedule an asynchronous job to upgrade the app with the given UUID and version from the App Catalog. The app will be installed in 'Installed Apps' folder in the Content Library.<br /><br />You get back an identifier of asynchronous job in response to this endpoint. You can then use the app upgrade status API to get the status of the upgrade request. See Asynchronous-Request section for more details on how to work with asynchronous request.

EXEC sumologic.apps.apps_v2.upgrade 
@uuid='{{ uuid }}' --required, 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set 
@@json=
'{
"version": "{{ version }}", 
"parameters": "{{ parameters }}"
}'
;