API

Bakery 2.0 is stateful, and includes a RESTful API for creating, reading, updating, and deleting its stateful resources. The stateful resources are:

  • Origin, which maintains a mapping between the FQDN of an multi-origin host and a short name for use with the origin filter. Invoked via the origin filter
  • RuleSet, which maintains one-to-one aliases for Bakery URI filter-paths. Invoked via the rule-set filter

Bakery 2.0 API consumes and produces objects of MIME-type application/json, and should include the appropriate Content-Type header, in each request:

  • Header Key: Content-Type
  • Header Value: application/json

Security

Bakery 2.0 API is protected from unauthorized access by means of a JSON Web Token (JWT) provided in the HTTP Request-Header. This header must be present with every requests (regardless of data modification):

Header Key: Authorization Header Value: dot-separated, based64-encoded JWT

Base URL

Bakery 2.0 API Base URLs take the form <bakery-host>/api/v1/<resource>/, i.e.: bakery.vtg.paramount.tech/api/v1/origin

api/index.md


Table of contents