snippets

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

Overview

Name	snippets
Type	Resource
Id	netlify.sites.snippets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	integer (int32)
site_id	string
general	string
general_position	string
goal	string
goal_position	string
title	string

list

Name	Datatype	Description
id	integer (int32)
site_id	string
general	string
general_position	string
goal	string
goal_position	string
title	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	site_id, snippet_id
list	select	site_id
create	insert	site_id
update	replace	site_id, snippet_id
delete	delete	site_id, snippet_id

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
site_id	string
snippet_id	string

SELECT examples

get

OK

SELECT
id,
site_id,
general,
general_position,
goal,
goal_position,
title
FROM netlify.sites.snippets
WHERE site_id = '{{ site_id }}' -- required
AND snippet_id = '{{ snippet_id }}' -- required
;

list

OK

SELECT
id,
site_id,
general,
general_position,
goal,
goal_position,
title
FROM netlify.sites.snippets
WHERE site_id = '{{ site_id }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO netlify.sites.snippets (
id,
site_id,
title,
general,
general_position,
goal,
goal_position,
site_id
)
SELECT 
{{ id }},
'{{ site_id }}',
'{{ title }}',
'{{ general }}',
'{{ general_position }}',
'{{ goal }}',
'{{ goal_position }}',
'{{ site_id }}'
RETURNING
id,
site_id,
general,
general_position,
goal,
goal_position,
title
;

Manifest

# Description fields are for documentation purposes
- name: snippets
props:
  - name: site_id
    value: "{{ site_id }}"
    description: Required parameter for the snippets resource.
  - name: id
    value: {{ id }}
  - name: site_id
    value: "{{ site_id }}"
  - name: title
    value: "{{ title }}"
  - name: general
    value: "{{ general }}"
  - name: general_position
    value: "{{ general_position }}"
  - name: goal
    value: "{{ goal }}"
  - name: goal_position
    value: "{{ goal_position }}"

REPLACE examples

update

No description available.

REPLACE netlify.sites.snippets
SET 
id = {{ id }},
site_id = '{{ site_id }}',
title = '{{ title }}',
general = '{{ general }}',
general_position = '{{ general_position }}',
goal = '{{ goal }}',
goal_position = '{{ goal_position }}'
WHERE 
site_id = '{{ site_id }}' --required
AND snippet_id = '{{ snippet_id }}' --required;

DELETE examples

delete

No description available.

DELETE FROM netlify.sites.snippets
WHERE site_id = '{{ site_id }}' --required
AND snippet_id = '{{ snippet_id }}' --required
;