Api¶
-
POST
/snippets
¶ Add new snippets
Status Codes: - 201 Created – Snippet created
- 400 Bad Request – Request not syntactically correct
- 403 Forbidden – Using client generated ID is not supported
- 500 Internal Server Error – Internal server error
-
GET
/snippets
¶ Search snippets
Query Parameters: - sall (array) – Search keywords from all fields.
- stag (array) – Search keywords only from tag field.
- sgrp (array) – Search keywords only from group field.
- digest (string) – Search only based on message digest field.
- data (string) – Search only from content data.
- filter (string) – Filter search result with provided regexp.
- limit (string) – Limit query result list.
- offset (string) – Offset from the beginning of search results.
- sort (string) – Sort based on defined field.
- fields (array) – Limit fields that are returned in result list.
Status Codes: - 200 OK – OK
- 400 Bad Request – Request not syntactically correct
- 404 Not Found – Snippet not found
- 500 Internal Server Error – Internal server error
-
POST
/snippets/{digest}
¶ Override POST with PUT, PATCH or DELETE
Parameters: - digest (string) – Unique snippet identified by message digest.
Status Codes: - 200 OK – Snippet updated
- 204 No Content – Snippet deleted
- 400 Bad Request – Request not syntactically correct
- 404 Not Found – Snippet not found
- 403 Forbidden – Using client generated ID is not supported
- 500 Internal Server Error – Internal server error
Request Headers: - X-HTTP-Method-Override – Override POST method.
-
PUT
/snippets/{digest}
¶ Update defined snippet based on digest
Parameters: - digest (string) – Unique snippet identified by message digest.
Status Codes: - 200 OK – Snippet updated
- 400 Bad Request – Request not syntactically correct
- 403 Forbidden – Using client generated ID is not supported
- 404 Not Found – Snippet not found
- 500 Internal Server Error – Internal server error
-
PATCH
/snippets/{digest}
¶ Update defined snippet based on digest
Parameters: - digest (string) – Unique snippet identified by message digest.
Status Codes: - 200 OK – Snippet updated
- 400 Bad Request – Request not syntactically correct
- 403 Forbidden – Using client generated ID is not supported
- 404 Not Found – Snippet not found
- 500 Internal Server Error – Internal server error
-
GET
/snippets/{digest}
¶ Search defined snippet based on digest
Parameters: - digest (string) – Unique snippet identified by message digest.
Status Codes: - 200 OK – OK
- 400 Bad Request – Request not syntactically correct
- 404 Not Found – Snippet not found
- 500 Internal Server Error – Internal server error
-
DELETE
/snippets/{digest}
¶ Delete defined snippet based on digest
Parameters: - digest (string) – Unique snippet identified by message digest.
Status Codes: - 204 No Content – Snippet deleted
- 400 Bad Request – Request not syntactically correct
- 404 Not Found – Snippet not found
- 409 Conflict – More than one snippet found
- 500 Internal Server Error – Internal server error
-
GET
/snippets/{digest}/{field}
¶ Search defined snippet based on digest
Parameters: - digest (string) – Unique snippet identified by message digest.
- field (string) – One of the resource field attributes.
Status Codes: - 200 OK – OK
- 400 Bad Request – Request not syntactically correct
- 404 Not Found – Snippet not found
- 500 Internal Server Error – Internal server error