Skip to main content

settings

Creates, updates, deletes, gets or lists a settings resource.

Overview

Namesettings
TypeResource
Iddigitalocean.security.settings

Fields

The following fields are returned by SELECT queries:

The response will be a JSON object with scan settings.

NameDatatypeDescription
plan_downgradesobject
settingsobject
tier_coverageobject

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
security_list_settingsselectper_page, pageTo list CSPM scan settings, send a GET request to /v2/security/settings.
security_update_settings_planreplaceTo update CSPM plan coverage, send a PUT request to /v2/security/settings/plan.

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.

NameDatatypeDescription
pageintegerWhich 'page' of paginated results to return. (example: 1)
per_pageintegerNumber of items returned per page (example: 2)

SELECT examples

To list CSPM scan settings, send a GET request to /v2/security/settings.

SELECT
plan_downgrades,
settings,
tier_coverage
FROM digitalocean.security.settings
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

REPLACE examples

To update CSPM plan coverage, send a PUT request to /v2/security/settings/plan.

REPLACE digitalocean.security.settings
SET
tier_coverage = '{{ tier_coverage }}'
RETURNING
tier_coverage;