# Snippets API
POST /v1/snippets
Add snippets.
```typescript
interface Request {
snippets: []Snippet
}
interface Response {
snippets: []Snippet
}
```
```bash
# Example
curl -X POST \
-H 'Authorization: ' \
-H 'Content-Type: application/json' \
'https://api.stormkit.io/v1/snippets' \
-d '{ "snippets": [{ "title": "Snippet title", "content": "Hello World", "enabled": true, "prepend": false, "location": "head", "rules": { "hosts": ["example.org", "*.dev"], "path": "/my-path" } }] }'
```
| Response | Definition |
| -------- | ---------------------------------------------------- |
| 201 | Snippet was created successfully. |
| 400 | Snippet is invalid. Check the `errors` array. |
| 409 | Snippet content is duplicate within the environment. |
On error, the response body contains an `errors` array:
```json
{ "errors": ["Snippet title is a required field."] }
```
GET /v1/snippets
Return all snippets of an environment.
```typescript
interface QueryString {
afterId?: string
hosts?: string
title?: string
}
interface Response {
snippets: []Snippet
pagination: Pagination
}
```
```bash
# Example
curl -X GET \
-H 'Authorization: ' \
'https://api.stormkit.io/v1/snippets'
```
```json
{
"snippets": [
{
"id": "1501",
"title": "Snippet title",
"content": "Hello World",
"enabled": true,
"prepend": false,
"location": "head",
"rules": {
"hosts": ["example.org", "*.dev"],
"path": "/my-path"
}
}
],
"pagination": {
"hasNextPage": false
}
}
```
To filter snippets by hosts, you can use the `hosts` querystring parameter. Multiple hosts should be separated by comma (`,`).
To filter snippets by title, use the `title` querystring parameter. Ensure the querystring is properly encoded.
To paginate results, you can specify the `afterId` querystring parameter. This value is returned in the first `GET` request.
PUT /v1/snippets
Update the given snippet.
```typescript
interface Request {
snippet: Snippet
}
interface Response {
ok: boolean
}
```
```bash
# Example
curl -X PUT \
-H 'Authorization: ' \
-H 'Content-Type: application/json' \
'https://api.stormkit.io/v1/snippets' \
-d '{ "snippet": { "id": 1501, "title": "New title", "content": "Hello World", "enabled": true, "prepend": false, "location": "head", "rules": { "hosts": ["example.org", "*.dev"], "path": "/my-path" } } }'
```
| Response | Definition |
| -------- | ---------------------------------------------------- |
| 200 | Snippet was updated successfully. |
| 400 | Snippet is invalid. Check the `errors` array. |
| 409 | Snippet content is duplicate within the environment. |
On error, the response body contains an `errors` array:
```json
{ "errors": ["Snippet title is a required field."] }
```
DELETE /v1/snippets
Delete snippets with the given ids. You can delete a maximum of `100` snippets at a time.
```typescript
interface QueryString {
ids: []string
}
interface Response {
ok: boolean
}
```
```bash
# Example
curl -X DELETE \
-H 'Authorization: ' \
'https://api.stormkit.io/v1/snippets?ids=1501,5061'
```
| Response | Definition |
| -------- | --------------------------------------------- |
| 200 | Snippets were deleted successfully. |
| 400 | Request is invalid. Check the `errors` array. |
On error, the response body contains an `errors` array:
```json
{ "errors": ["ID should be an integer."] }
```
#### Syntax
```typescript
interface Snippet {
id: string
title: string
content: string
enabled: boolean
location: 'head' | 'body'
prepend: boolean
rules?: {
hosts?: []string
path?: string
}
}
interface Pagination {
hasNextPage: boolean
afterId?: string
}
```
| Property | Definition |
| ----------- | -------------------------------------------------------------------------------------------------------- |
| id | The unique id of the snippet. |
| title | The title is used internally for describing what the snippet does. |
| content | The content that is going to be injected into the page. |
| enabled | Whether the snippet is enabled or not. |
| location | The injection location for the snippet. |
| prepend | If true, the snippet will be injected as the first child to the `location`. Otherwise as the last child. |
| rules.hosts | Inject snippet only for the provided hosts. |
| rules.path | If specified, snippet will be injected only when the path matches. |
**Note:** To inject snippets for all development endpoints, specify `*.dev` for the `rules.hosts` property. Specifying an individual deployment endpoint will enable the snippet for all development endpoints.