Skip to main content
POST
Create an action

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

Create a cost-saving action.

Name the resource the action applies to with exactly one of srn or insight_id. If you have the resource's identifying details but not its SRN, resolve one first with POST /v2/srn/actions/resolve. An action on an insight must name it with insight_id.

user_email defaults to the calling user. actioned_time defaults to now; set it to backdate the action. An API key has no user identity, so a key-authenticated caller must set user_email.

title
string
required
Maximum string length: 200
savings_type
enum<string>
required
Available options:
manual,
calculated,
calculated_smart_suspend
comment
string | null
user_email
string

Email of the person who took this action. Defaults to the calling user. Required for an API key, which has no user identity. Cannot be null.

Minimum string length: 1
actioned_time
string<date-time>

When the action was taken, as an RFC 3339 timestamp. Defaults to now. Set it to backdate the action; savings are then measured from that day. Converted to UTC; a timestamp with no offset is read as UTC. Cannot be null.

end_date
string<date> | null
srn
string | null

The canonical SELECT Resource Name (SRN) of the resource this action applies to. Resolve one from a resource's identifying details with POST /v2/srn/actions/resolve. An empty string scopes the action to the whole organization. Insight SRNs are rejected — name an insight with insight_id instead.

Maximum string length: 2048
insight_id
string<uuid> | null
savings_amount
number | null
savings_rate_percent
number | null
select_feature
enum<string> | null
Available options:
smart_suspend,
apc_automated_savings,
dbx_warehouse_automated_savings,
jcss_automated_savings
resource_metadata
ResourceMetadata · object | null
team_id
string<uuid> | null

Response

Successful Response

A cost-saving action taken on a Snowflake resource, with its measured savings.

id
string
required
title
string
required
srn
string
required
user_email
string
required
actioned_time
string
required
created_by
string
required
srn_resource_type
string
required
create_time
string
required
update_time
string
required
etag
string
required
read-only

Opaque strong ETag.

comment
string | null
end_date
string<date> | null
insight_id
string | null
insight_type
string | null
savings_type
enum<string> | null
Available options:
calculated,
manual
savings_amount
number | null
savings_rate_percent
number | null
savings_override_percent
number | null
current_daily_savings
number | null
current_annualized_savings
number | null
current_realized_savings
number | null
savings_status
enum<string> | null
Available options:
pending,
calculated,
error,
unsupported
savings_calculation_metadata
SavingsCalculationMetadata · object | null
savings_materialized_through
string<date> | null
select_feature
enum<string> | null
Available options:
smart_suspend,
apc_automated_savings,
dbx_warehouse_automated_savings,
jcss_automated_savings
resource_metadata
ResourceMetadata · object | null
team_id
string | null
updated_by
string | null