New API version v6.12.5 has been released! 🎉
REST Documentation
Introduction

REST-API Documentation

Use ZEP's REST API to ensure seamless and powerful integration into your product.

First steps

To be able to use the REST interface of ZEP, you need the ZEP interfaces module, which you can activate via the self-service tool. If you have done this, you can generate an API token in the new module to access the REST API. Below you will find help on how to make requests to the ZEP resources using the API.

Guides

Quickstart

Set up the API and send the first request.

Authentication

Find out how you can authenticate your API requests.

Pagination

Understand how to work with paginated answers.

Filtering the results

Understand how to filter the results using query parameters.

OpenAPI specification

Here you can download the OpenAPI specification of our REST API.

Resources

Once you have activated the module and generated a bearer token, you can make your first call to the API. On the following pages you will find detailed information on the individual resources and their attributes.