Get site metadata

GET

/wp-json/wp2/site-manager/v1/sites/{blog_id}

curl --request GET \
  --url https://example.com/wp-json/wp2/site-manager/v1/sites/1 \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Metadata for one site: blogname, slug, WP_Site flags, Site Manager status/categories. Not post content.

    Requires permission to manage this blog (`manage_network` / super admin / `manage_options` on the site). Another network site without permission — 403 `forbidden`.

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

blog_id

required

integer

Site ID in the current network (WP_Site->blog_id). A site from another network — 404 site_not_in_network.

Query Parameters

include

string

If the string contains stats, the response includes user_count. Otherwise PHP omits the field.

Responses

200

Body is SiteMetadata::to_array.

Media typeapplication/json

object

blog_id

Site ID in the current network (WP_Site->blog_id). Path {blog_id} on the same operations is the same number.

integer

network_id

ID of the network the site belongs to (WP_Site->site_id). Not blog_id and not CreateNetworkRequest.domain.

integer

title

Site title — blog option blogname (get_option on this site). Not the network option site_name.

string

slug

Site address slug. On SUBDOMAIN_INSTALL — subdomain relative to the network domain; otherwise the WP_Site->path segment without slashes. PHP derives it in SiteSlugService::derive_slug_from_site.

string

domain

Site host in the blogs table (WP_Site->domain), without an https:// scheme.

string

path

Site path in the blogs table (WP_Site->path) with slashes (often / on subdomains or /training/ on subdirectory). Not a Local Sync file path.

string

description

Site tagline — blog option blogdescription.

string

status_id

Site Manager status taxonomy term ID (site meta wp2platform_site_status). null if unset or id=0.

integer

nullable

status

Expanded Site Manager status term. null if unset. Not the WP_Site->public flag.

object

id

Status term_id.

integer

name

Status display name.

string

slug

Status term slug (sanitize_title).

string

category_ids

Site Manager category term IDs (site meta wp2platform_site_categories).

Array<integer>

categories

Expanded site categories (id, name, slug). PHP does not include parent inside SiteDto.

Array<object>

object

id

Site category term_id (Site Manager taxonomy, not post categories).

integer

name

Term display name. In the list PHP may rewrite default labels via translate_default_term_label.

string

slug

Category term slug (sanitize_title on write).

string

parent

Parent term_id (WP_Term->parent); 0 — root. PHP omits this field in SiteDto.categories.

integer

site_url

Public site URL (get_site_url(blog_id)).

string format: uri

admin_url

This site’s wp-admin URL (get_admin_url(blog_id)), not /wp-admin/network/.

string format: uri

registered

Blog registration date (WP_Site->registered), as core stores it.

string format: date-time

last_updated

Blog last-updated date (WP_Site->last_updated).

string format: date-time

public

WP_Site->public flag (1 — public/active, 0 — unpublished). Not a Site Manager status term.

integer

archived

WP_Site->archived flag (1 — archived, 0 — not).

integer

deleted

WP_Site->deleted flag in the blogs table (core marked the site deleted). Not the result of this API’s DELETE.

integer

spam

WP_Site->spam flag (1 — marked as spam).

integer

mature

WP_Site->mature flag.

integer

is_main_site

True if this is the network main site (is_main_site(blog_id)). It cannot be deleted, archived, deactivated, or have its slug changed via this API (main_site_forbidden / main_site_slug_forbidden).

boolean

is_template

True if site meta wp2platform_site_manager_is_template is 1 (duplication template site).

boolean

user_count

User count on the site (count_users()['total_users']). PHP adds the field only if query include contains stats; otherwise the key is absent.

integer

Example

{
  "blog_id": 5,
  "network_id": 1,
  "title": "Training project",
  "slug": "training",
  "domain": "training.example.com",
  "path": "/",
  "public": 1,
  "archived": 0,
  "is_main_site": false,
  "is_template": false
}

401

Not authenticated. DualRest: rest_forbidden (status 401) when there is no cookie session. Cookie + X-WP-Nonce or Application Password.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

No permission on this blog (forbidden) or invalid REST nonce.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

404

Site_not_in_network — site is not in the current network; site_not_found — no such blog.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}