API Reference

This section provides API Reference Documentation for the APIs you'll use when developing on platformOS.

platformOS REST API

The platformOS REST API Reference includes:

• Detailed descriptions of calls and parameters
• Example requests with the explanation of different elements
• Example responses with the explanation of different elements
• Detailed descriptions of error codes

Complete Guide to Liquid Markup

Liquid is a template language used in platformOS to build dynamic pages, and to provide dynamic configuration. We have added platformOS-specific filters and tags to make your life easier. Our complete guide to Liquid markup includes:

• Introduction
• Types
• Tags
• Filters
• Whitespace control
• Detailed descriptions of platformOS-specific filters and tags
• Examples for all of the above

GraphQL API

GraphQL is query language used to communicate with our data storages. Our GraphQL API Reference includes:

• Glossary
• Queries
• Mutations
• Objects
• Scalars
• Interfaces
• Enums
• Inputs

Was this page helpful?

Contribute to this page

Thank you. We have received your feedback.

If you would like to give us more details, please do so below.

We’re glad you liked our documentation page!
Why did you like it? How could we make it even better? We are continuously working on our docs to make them better.
How do you think we could improve this page? We’re sorry you didn’t like our documentation page.
What was the problem? How do you think we could fix it?

Would you like to get an answer from us?

Send