Advertising sustains the DA. Ads are hidden for members. Join today

REST API examples and documentation

Last updated on
30 April 2025

Overview

The REST API provided by Services is hard to understand if you've never used Services before and don't understand what are the right URLs to call, what parameters to pass or how to pass them.

There's an effort to document the Services REST API just like you'd expect it documented in any big site, like Twitter or Facebook, it includes the right URL, parameters, how a response would look and more.

You can find the documentation at Drupanium (offline!) and help us to detect errors and contribute with more resources. Most resources are already documented, including resources that contributed modules provide, like Views or Flag.

Drupal Services REST API Documentation

For the quick and dirty, a README.md included in the repo documents REST basics concisely:
http://cgit.drupalcode.org/services/tree/servers/rest_server/README.mark...

Does anyone have a definitive link or Handbook page that documents the specific endpoint controller API? Things like: Valid 'source' values and what they mean, best practices for file structure ("./resources/object/action").. etc. Please replace this and document here.

Help improve this page

Page status: Not set

You can: