# WordPress Blueprints
Create reusable WordPress installation presets (themes, plugins, and site settings) and apply them when deploying new WordPress applications.
Requires an active WordPress Toolkit add-on on the account that owns the blueprints (purchase via the ServerAvatar dashboard; not available through the API).
# List Account Blueprints
Paginated list of blueprints for the authenticated user.
# HTTP Request:
GET https://api.serveravatar.com/wordpress-blueprints
# Curl Request Example:
curl --request GET \
--url "https://api.serveravatar.com/wordpress-blueprints" \
--header 'Authorization: <YOUR API TOKEN>'
# Query Parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
| per_page | No | Integer | Results per page (default 10) |
# Response:
# Successful Response
- 200 (Ok)
{
"message": "WordPress blueprints fetched successfully.",
"blueprints": {
"data": [
{
"id": 71,
"user_id": 1,
"hosting_user_id": null,
"name": "E Commerce",
"selected_plugins": [
{
"name": "Welcart e-Commerce",
"slug": "usc-e-shop",
"activate": true,
"icon_url": "https://ps.w.org/usc-e-shop/assets/icon.svg?rev=2072308"
}
],
"selected_themes": [
{
"name": "Ecommerce Marketplace",
"slug": "ecommerce-marketplace",
"activate": true,
"screenshot_url": "//ts.w.org/wp-content/themes/ecommerce-marketplace/screenshot.png?ver=0.0.2"
}
],
"custom_theme_plugins": null,
"remove_hello_world": true,
"remove_sample_page": true,
"delete_all_themes": true,
"delete_all_plugins": true,
"delete_unneeded_core_file": true,
"language": "en_US",
"timezone": "Etc/UTC",
"date_format": "F j, Y",
"time_format": "g:i a",
"se_indexing_disable": true,
"organize_upload_folders": true,
"permalink_structure": "/%postname%/",
"debug_mode": true,
"debug_log": true,
"debug_error": true,
"created_at": "2026-05-15T07:48:59.000000Z",
"updated_at": "2026-05-15T07:48:59.000000Z"
}
]
}
}
# List Organization Blueprints
List blueprints available when creating a WordPress app in an organization (organization owner or hosting user).
# HTTP Request:
GET https://api.serveravatar.com/organizations/{organization}/wordpress-blueprints
# Curl Request Example:
curl --request GET \
--url "https://api.serveravatar.com/organizations/5/wordpress-blueprints" \
--header 'Authorization: <YOUR API TOKEN>'
# Response:
# Successful Response
- 200 (Ok)
{
"message": "Organization WordPress blueprints fetched successfully.",
"blueprints": [
{
"id": 49,
"user_id": 1,
"hosting_user_id": null,
"name": "test",
"selected_plugins": [
{
"name": "LiteSpeed Cache",
"slug": "litespeed-cache",
"activate": true,
"icon_url": "https://ps.w.org/litespeed-cache/assets/icon-128x128.png?rev=2554181"
}
],
"selected_themes": [
{
"name": "VYROLA",
"slug": "vyrola",
"activate": true,
"screenshot_url": "//ts.w.org/wp-content/themes/vyrola/screenshot.png?ver=1.0.1"
}
],
"custom_theme_plugins": null,
"remove_hello_world": true,
"remove_sample_page": true,
"delete_all_themes": true,
"delete_all_plugins": true,
"delete_unneeded_core_file": true,
"language": "en_US",
"timezone": "Etc/UTC",
"date_format": "F j, Y",
"time_format": "g:i a",
"se_indexing_disable": true,
"organize_upload_folders": true,
"permalink_structure": "/%postname%/",
"debug_mode": true,
"debug_log": true,
"debug_error": true,
"created_at": "2026-05-13T09:57:11.000000Z",
"updated_at": "2026-05-13T09:57:11.000000Z"
}
]
}
# Unauthorized
- 403 (Forbidden)
{
"message": "You are not authorized to access this resource."
}
# Browse Public Themes
Proxy to the WordPress.org theme directory API. Does not require the toolkit add-on.
# HTTP Request:
GET https://api.serveravatar.com/wordpress-blueprints/themes
# Curl Request Example:
curl --request GET \
--url "https://api.serveravatar.com/wordpress-blueprints/themes" \
--header 'Authorization: <YOUR API TOKEN>'
# Query Parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
| search | No | String | Search term (max 120 characters) |
| page | No | Integer | Page number (min 1) |
| per_page | No | Integer | Results per page (1–100, default 20) |
| browse | No | String | featured, popular, new, or updated |
# Browse Public Plugins
Proxy to the WordPress.org plugin directory API. Does not require the toolkit add-on.
# HTTP Request:
GET https://api.serveravatar.com/wordpress-blueprints/plugins
# Curl Request Example:
curl --request GET \
--url "https://api.serveravatar.com/wordpress-blueprints/plugins" \
--header 'Authorization: <YOUR API TOKEN>'
# Query Parameters:
Same as Browse Public Themes, with browse also allowing beta.
# Response (public theme/plugin browse):
# Successful Response
- 200 (Ok)
{
"message": "Public WordPress themes fetched successfully.",
"themes": [],
"info": {}
}
# Apply Blueprint During Application Creation
When creating a WordPress application with the Create Application API, pass wordpress_blueprint_id in the request body. ServerAvatar installs WordPress first, then applies the blueprint (themes, plugins, cleanup, language, timezone, permalinks, debug options, and related settings).
| Parameter | Required | Type | Description |
|---|---|---|---|
| wordpress_blueprint_id | No | Numeric | Blueprint ID from List Account Blueprints or List Organization Blueprints |
The blueprint must belong to the authenticated API user, or to the organization owner when using an organization API token. Omit this field to create a standard WordPress site without a blueprint preset.
Example (excerpt):
{
"name": "my-wp-site",
"method": "one_click",
"framework": "wordpress",
"wordpress_blueprint_id": 12
}
See Create Blueprint (includes custom theme/plugin ZIP upload and link_source), Show Blueprint, Update Blueprint, and Delete Blueprint for blueprint CRUD.