Skip to main content
Version: 0.14

RESTful entity CRUD API

This section describes the functionality of the RESTful CRUD API generated by both of the following mechanisms:

  1. Exporting a route using the crud() function on a ChiselEntity subclass.
  2. Use of the ChiselNow quickstart tool.

In either case, it's assumed here that you know the endpoint URL that was generated for you, and are able to use that to construct HTTP requests as described.

note

For ChiselNow projects, when invoking methods that can mutate data (all non-GET requests) you must add your API key in the X-Token request header, like this:

curl \
    -X DELETE \
    -H "X-Token: [YOUR-TOKEN]"
    "https://host/dev/entity/[GENERATED-ID]"