Delivery API

Delivery API tells you information about how to "serve a request". This API is the backbone of hosting a blog on a subdirectory.

API Endpoint: https://blogs.hyvor.com/api/delivery/v0/{subdomain}

Replace {subdomain} with the subdomain of your blog.

Request

• GET request to the API endpoint
• Set api_key query parameter to a valid Delivery API key. You can create one at Settings → API Keys.
• Set path query parameter to the path of the blog you want to get information about. For example, if you want to get information about https://myblog.com/hello-world, set path to /hello-world/.

Response

A successful response will be one of the following JSON objects:

1. File

This object is returned when the path is a file.

{
    "type": "file",
    "at": 1661590503,
    "cache": true,
    "status": 200,
    "file_type": "template",
    "content": "SGVsbG8gV29ybGQ=",
    "mime_type": "text/html",
    "cache_control": "no-cache, private"
}

2. Redirect

This object is returned when the path is a redirect.

{
    "type": "redirect",
    "at": 1661590503,
    "cache": true,
    "status": 301,
    "to": "https://example.com"
}

Common properties:

File properties:

Redirect properties: