Get one Platform module

GET

/wp-json/wp2/modules/v1/modules/{id}

curl --request GET \
  --url 'https://example.com/wp-json/wp2/modules/v1/modules/example?scope=network' \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Authorizations

• cookie
• applicationPassword
• bearerToken

Parameters

Path Parameters

id

required

string

Module id (e.g. turbo, post_cache, live_mode)

Query Parameters

scope

string

default: network

Allowed values: network site

Responses

200

Module DTO

Media typeapplication/json

object

id

Module id.

string

name

Display name.

string

enabled

Resolved enable via is_module_enabled.

boolean

default_enabled

boolean

network_only

boolean

forced_by_network

Network map forces on for site scope.

boolean

can_be_enabled

boolean

can_be_disabled

boolean

dependency_warning

string

nullable

category

Category id.

string

locked

Site UI locked when forced_by_network.

boolean

Example

{
  "id": "turbo"
}

404

Module_not_found

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": {}
}