Introduction

Regle API is organized around REST, with predictable resource-oriented URLs and uses standard HTTP response codes and verbs.

Regle's API is versioned and current stable version is V2, released on 2022-10-07.

Authentication

Regle uses API key for authentication.

You can view and manage your API keys in the Regle Admin UI.

API key needs to be provided in an HTTP header X-Regle-ApiKey for all API endpoints.

You must make all API calls over HTTPS. Calls that you make over plain HTTP will fail. API requests without authentication will also fail.

Testing Authenticated Requests with curl
curl -s -XGET \
    -H 'Content-Type: application/json' \
    -H "X-Regle-ApiKey: $REGLE_API_KEY" \
    https://api.regle.dev/v2/hello

# This is a no-op endpoint to test that your API key is valid
# Returns "OK" if API key is valid otherwise and error is returned.

Authentication​

Authentication