List sites

get https://api.wp.pro/v1/sites

Response

Response body

object

success

boolean

required

Success indicator

message

string

Human readable (error) message

result

object

Query result

count

number

sites

array of objects

sites

object

created_at

string

required

active_since

string

removed_at

string

deletion_protection

boolean

required

environment

object

required

_stats

object

Available only for GET /site/{site_id} calls

string

required

The sites unqiue hash/id

status

string

required

Current site status

new pending active error

hostname

string

required

Unique default hostname

name

string

required

Sites individual name

addons

array of strings

Connected addons

addons

region

string

required

Defaults to us_central_1

Geographic location (compute region) of the master site

us_central_1 eu_central_1 eu_west_1

config

object

Configuration details (if site has status 'active')

Language

Credentials

Header


xxxxxxxxxx
1
import wppro from '@api/wppro';
2
3
wppro.sitesList({space_id: '%28none%29', status: 'active'})
4
  .then(({ data }) => console.log(data))
5
  .catch(err => console.error(err));


xxxxxxxxxx
72
}
1
{
2
  "success": true,
3
  "message": "string",
4
  "result": {
5
    "count": 0,
6
    "sites": [
7
      {
8
        "created_at": "string",
9
        "active_since": "string",
10
        "removed_at": "string",
11
        "deletion_protection": true,
12
        "environment": {
13
          "role": "Production",
14
          "name": "string",
15
          "master": true
16
        },
17
        "_stats": {
18
          "performance_score": {
19
            "metric": "string",
20
            "datetime": "2025-04-13T04:07:20.681Z",
21
            "value": 0
22
          },
23
          "uptime_seconds": {
24
            "metric": "string",
25
            "datetime": "2025-04-13T04:07:20.681Z",

200Success Response