Wordpress Multisite JSON API

This is a Wordpress Plugin that adds JSON endpoints for creating, listing, and deleting sites on multisite.

PHP Versions

Support PHP > 5.3

Security

For list, create or delete is required use POST and Basic Auth.

Make sure you limit access to the enpoints! You should not allow any yahoo off the internet to scan your site and look for these endpoints. I highly recommend some sort of .htaccess or nginx configuration settings to deny access to all but the local addresses you use for the API clients.

Something like this maybe:

Apache:

<Location /srv/wordpress/wp-content/plugins/multisite-json-api/endpoints>
DenyFrom All
AllowFrom 127.0.0.0/24 10.0.0.0/8
</Location>

Nginx:

location /wp-content/plugins/multisite-json-api/endpoints {
	deny all;
	allow 127.0.0.0/24 10.0.0.0/8;
}

Also, as of right now all user names and password are passed through http Headers. That means SSL is pretty much mandatory.

API Documentation

Authentication

All of the enpoints require you to authenticate with an existing wordpress user. Currently all require the superadmin role, but that may change.

Username and password are passed with the HTTP Headers User and Password respectively. These are plain text so you need to be using SSL (which you are doing already right?).

Create Site

• URL: /wp-json/wp-multisites/v1/create
• Method: POST
• Payload example: {"email": "user@example.com", "site_name": "awesomeblog", "title": "Awesome Blog"}
• Description: Creates a site. If the email address does not exist this will create a new user with that email address. The site_name is the path or subdomain you would like to use.

List Sites

• URL: /wp-json/wp-multisites/v1/create
• Method: POST
• Payload example: No payload
• GET Variables: public, spam, archived, deleted
• Description: Lists sites by wordpress tags. All of the variables are boolean 0 or 1, and will list sites where that variable is set to the boolean provided. For example: ?public=1&deleted=0 will list all sites that are public but not deleted.

Delete Site

• URL: /wp-json/wp-multisites/v1/delete
• Method: DELETE
• Payload example: {"blog_id": 49, "drop": false}
• Description: Deletes a site. If drop is set to true wordpress will remove the site from the database completely. Otherwise the only thing this does is set the deleted attribute on the site to true.

License

Same as WordPress GPLv2.

Based on the work of @remkade https://github.com/remkade/multisite-json-api