Console API

The Console API is not yet ready for public access. This documentation is WIP...

The Console API allows you to do administrative tasks of a blog. This is the same API we use internally in the Console. You can use it to automate some tasks or even build a completely new mini-console by yourself.

Calling the API

• API Basepath: https//blogs.hyvor.com/api/console/v0/blog/{subdomain}
• Create a Console API Key from the Console and send it as the X-API-KEY header.
• Console API endpoints use the following HTTP methods.
  • GET - to get data, usually an array of resources
  • POST - to create a resource
  • PATCH - to partially update a resource
  • PUT - to completely update an resource
  • DELETE - to delete a resource
• Similarly to our Data API, the Console API always return an object or an array of objects, in JSON format
• Request params can be set as JSON (recommended) or as usual request params (in query or HTTP body)
• In this documentation, objects, request params, and responses are written as Typescript interfaces in order to make type declarations concise.

Categories

The Console API is huge, and is categorized by what "resource" you want to access or manage. Most categories have CRUD operations but some may have more endpoints for specific tasks. These objects are defined within the Category. Also, note that Console API objects are different from Data API objects.

Jump to each category:

• Posts & Pages
• Tags
• Users
• Media
• Navigation
• Languages
• Redirects
• Webhooks
• Theme Files
• Data Import
• Data Export
• Billing
• Blog Settings
• Blog Meta Data
• Other Endpoints

Posts & Pages

Endpoints

• GET /posts - Get posts
• GET /pages - Get pages
• POST /post - Create a post/page
• GET /post/{id} - Get a post/page
• PATCH /post/{id} - Update a post/page
• DELETE /post/{id} - Delete a post/page
• POST /post/{id}/variant - Create a post language variant
• DELETE /post/{id}/variant - Delete a post language variant