Skip to content
WP2WP2

Get network

GET
/wp-json/wp2/multi-network/v1/networks/{network_id}
curl --request GET \
  --url https://example.com/wp-json/wp2/multi-network/v1/networks/1 \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Metadata for one WordPress network (domain, path, and related fields) looked up by network id.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
network_id
required
integer

Parameter “network_id”.

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
network_id

WordPress network ID (WP_Network->id). Same number as GET …/networks/{network_id}.

integer
domain

Network host as stored in wp_site (no scheme). Matches create input after lowercasing.

string
path

Network path with a trailing slash (add_network trailingslashit). Usually /.

string
site_id

Root site ID of this network (WP_Network->site_id), not the network ID.

integer
site_name

Root site blogname (get_blog_option site_id, blogname). Site title, not a network option.

string
network_name

Network option site_name (get_network_option). Set from request network_name when provided.

string
admin_url

Network admin URL {scheme}://{domain}{path}wp-admin/network/. scheme is https when is_ssl().

string format: uri
site_url

Root site URL {scheme}://{domain}{path}.

string format: uri
Example
{
  "network_id": 2,
  "domain": "network2.example.com",
  "path": "/",
  "site_id": 5,
  "site_name": "Network root site",
  "network_name": "Network Two",
  "admin_url": "https://network2.example.com/wp-admin/network/",
  "site_url": "https://network2.example.com/"
}

401

Section titled “401”

Not authenticated. WordPress REST: rest_not_logged_in / rest_forbidden. Use 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
Examplegenerated
{
  "code": "example",
  "message": "example",
  "data": {}
}

403

Section titled “403”

Insufficient capability or invalid REST nonce. WordPress REST: rest_forbidden / rest_cookie_invalid_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
Examplegenerated
{
  "code": "example",
  "message": "example",
  "data": {}
}