1. Home
  2. Docs
  3. API
  4. REST API basics
  5. Method and URI

Method and URI

The generated API for all your model is consistent. It uses the following set of methods:

GET — is used for reading and retrieving data. Parameters resides in the url and query string. The body is ignored.

POST — is used for inserting data or for using the QueryBuilder Parameters resides in the url and body.

PATCH — is used for updating data. Parameters resides in the url and body.

DELETE — is used for deleting data. Parameters resides in the url and body.

PUT — Upload files

HEAD — To be use to get information on an entity

The base uri to use is https://x.apigoat.com/p/{$projectName}/api/v1/

All request should include the “content-type: application/json” header.

How can we help?

Leave a Reply