API Documentation

Introduction
Authentication
- Request Access Token
- Revoke Access Token
Account
Collaborators
DNS
Edge Cache
Must-Use Plugins
On-Demand Backups
Plugins
Security Alerts
- Plugin Alerts
- Theme Alerts
Sites
Themes
WordPress
Webhooks
Errors
Job Queues

Introduction

The Pressable API is a REST based API. We accept form-encoded request bodies and return JSON encoded responses. Our API is used by our customers for building custom user interfaces and automating day-to-day operations.

All of our examples are shown using curl. We recommend using Postman for testing your API interactions.

Authentication

OAuth authentication using a provided client id and client secret, which are supplied in the control panel.

Obtain Access Token

Authentication provides an access token in the response that is required for making requests to the API. Access tokens are active for 1-hour, you should request a new token before the current token expires. The access token provided in the response must be supplied in the standard HTTP Authorization header as Bearer token authentication to make requests to the API.

Authorization: "Bearer <bearer-token>"

curl --location --request POST 'https://my.pressable.com/auth/token' \
--form 'grant_type="client_credentials"' \
--form 'client_id="QbWIe7vxfNzZ1vZ7_YFIDNm_NCD7b5X43A68QX4qfzk"' \
--form 'client_secret="V8uqwz5sL0PdNVm8MUNo5WfdGdm_s1g4BMYSVF47H4k"'

POST Data

grant_type (required)

value is always 'client_credentials'

client_id (required)

provided in panel

client_secret (required)

provided in panel

{
    "access_token": "tXJSK-RX1GxSPyjLNvz7TkXwl1SuWoKgp4mwQYg5GjM",
    "token_type": "Bearer",
    "expires_in": 3599,
    "scope": "authorized",
    "created_at": 1686949418,
    "id": 1,
    "name": "John Doe",
    "email": "johndoe@pressable.dev",
    "gravatar": "https://www.gravatar.com/avatar/3b0e9a78b5621fce924f7ce107180970371cf75f565dfaa5e4babe2e4866422a?d=mp",
    "scopes": [
        "authorized",
        "owner"
    ]
}

Revoke Access Token

Revoke an access token to stop the access token from being able to make API requests.

curl --location --request POST 'https://my.pressable.com/auth/revoke' \
--form 'token="F-piwSMTor9L1nvM1mtf_j8uVI9KmLL-1qHh7WXREq4"' \
--form 'client_id="QbWIe7vxfNzZ1vZ7_YFIDNm_NCD7b5X43A68QX4qfzk"' \
--form 'client_secret="V8uqwz5sL0PdNVm8MUNo5WfdGdm_s1g4BMYSVF47H4k"' \

POST Data

token (required)

access token being revoked

client_id (required)

provided in panel

client_secret (required)

provided in panel

No response body

Account

Account profile and settings information.

Account Details

Get your account profile information.

curl --location --request GET 'https://my.pressable.com/v1/account' \
--header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8DnJskv4'

Parameters

No parameters

{
  "message": "Success",
  "data": {
    "affiliate": false,
    "collaboratorCount": 0,
    "email": "johndoe@pressable.dev",
    "gravatar": "https://www.gravatar.com/avatar/3b0e9a78b5621fce924f7ce107180970371cf75f565dfaa5e4babe2e4866422a?d=mp",
    "name": "John Doe",
    "organization": "Personal",
    "pageViews": {
      "allTime": {
        "people": 0,
        "views": 0
      },
      "lastTwoYearsIsAllTime": {
        "people": 0,
        "views": 0
      },
      "currentMonth": {
        "people": 0,
        "views": 0
      },
      "lastMonth": {
        "people": 0,
        "views": 0
      },
      "today": {
        "people": 0,
        "views": 0
      },
      "twoMonthsAgo": {
        "people": 0,
        "views": 0
      },
      "yesterday": {
        "people": 0,
        "views": 0
      }
    },
    "phoneNumber": "5551111510",
    "preview": false,
    "productName": "Pro",
    "defaultPhpVersion": "8.1",
    "defaultDatacenter": null,
    "maxSites": 10,
    "sitesCount": 8,
    "capacity": {
        "sites": {
            "maxBillable": 10,
            "maxStaging": 11,
            "billable": 8,
            "staging": 1,
            "total": 9
        }
    },
    "recent_activity": []
  },
  "errors": null
}

Responses

Number

Message

Code

200

Success

Set Account PHP Version

Set a default PHP version for all new sites created in your account.

Valid PHP Versions:8.2, 8.3 or 8.4

curl --location --request PUT 'https://my.pressable.com/v1/account' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw' \
--header 'Content-Type: application/json' \
--data-raw '{
  "php_version": "8.2"
}'

Parameters

php_version (required)

8.2, 8.3 or 8.4

{
  "message": "Success",
  "data": null,
  "errors": null
}

Responses

Number

Message

Code

200

Success

Set Account Datacenter

Set a default Datacenter for all new sites created in your account.

Valid Datacenter Codes:AMS or BUR or DCA or DFW or null

Setting a datacenter to null will remove your default datacenter and new sites will be created using the "No Preference" setting or the datacenter selected during site creation.
{ "datacenter_code": null }

curl --location --request PUT 'https://my.pressable.com/v1/account' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw' \
--header 'Content-Type: application/json' \
--data-raw '{
  "datacenter_code": "BUR"
}'

Parameters

datacenter_code (required)

AMS or BUR or DCA or DFW or null

{
  "message": "Success",
  "data": null,
  "errors": null
}

Responses

Number

Message

Code

200

Success

Account Activity Logs

Get a list of your activity logs to track actions within your account. Logs, available for the previous 60 days, can shed light on activities on your account. Please note that we provide up to 50 log messages per page in our responses.

curl --location --request POST 'https://my.pressable.com/v1/account/logs/activity' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImzvz' \
--header 'Content-Type: application/json' \
--data-raw '{
      "page": 1,
      "per_page": 5,
      "filters": [
          {
              "field": "action",
              "operator": "contains",
              "value": "report"
          },
          {
              "field": "account_email",
              "operator": "equals",
              "value": "systems@pressable.com"
          }
     ]
  }'

Page

The page integer is used to get the specified page of data for your request.

Per Page

The per_page integer is used to limit the amount of log messages for your request (max of 50 log messages per page).

Filters

Use the filters array to refine the results of returned activities in the response. You can incorporate multiple filters within this array. Each filter should contain a field, operator, and value. The 'field' specifies which data point to filter, the 'operator' can be either 'equals' or 'contains', and the 'value' is the specific data you're filtering for. You can filter using the following available fields:

action
account_email
ip_address
source ( ui | api.v1 | systems )

Filter Actions

Filter actions can be set to any one of the following values returned from the account-actions activity endpoint.

Parameters

Page

page

integer

(body)

Per Page

per_page

integer

(body)

Filters

filters

array

(body)

{
    "message": "Success",
    "data": [
      {
        "id": 2243,
        "timestamp": "2023-10-13T20:11:57.216Z",
        "accountEmail": "help@pressable.com",
        "ipAddress": "199.199.244.41",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
        "name": "settings",
        "description": "Settings Updated",
        "source": "ui",
        "message": "Webhook successfully deactivated [ https://1c89-199-199-41.ngrok-free.app/webhooks/pressable ]"
      },
      {
        "id": 2238,
        "timestamp": "2023-10-13T19:48:07.150Z",
        "accountEmail": "help@pressable.com",
        "ipAddress": "199.199.244.41",
        "userAgent": "PostmanRuntime/7.33.0",
        "name": "site.created",
        "description": "Site Created",
        "source": "api.v1",
        "message": "Created live site"
      },
      {
        "id": 2237,
        "timestamp": "2023-10-13T19:47:03.368Z",
        "accountEmail": "help@pressable.com",
        "ipAddress": "199.199.244.41",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
        "name": "settings",
        "description": "Settings Updated",
        "source": "ui",
        "message": "Webhook successfully activated [ https://1c89-199-199-41.ngrok-free.app/webhooks/pressable ]"
      },
      {
        "id": 2235,
        "timestamp": "2023-10-13T19:45:20.710Z",
        "accountEmail": "help@pressable.com",
        "ipAddress": "199.199.244.41",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
        "name": "settings",
        "description": "Settings Updated",
        "source": "ui",
        "message": "Updated Webhook for https://1c89-199-199-41.ngrok-free.app/webhooks/pressable"
      },
      {
        "id": 2221,
        "timestamp": "2023-10-13T18:01:42.751Z",
        "accountEmail": "help@pressable.com",
        "ipAddress": "199.199.244.41",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
        "name": "site.deleted",
        "description": "Site Deleted",
        "source": "ui",
        "message": "Deleted"
      },
      {
        "id": 2220,
        "timestamp": "2023-10-13T18:01:24.931Z",
        "accountEmail": "help@pressable.com",
        "ipAddress": "199.199.244.41",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
        "name": "site.deleted",
        "description": "Site Deleted",
        "source": "ui",
        "message": "Deleted"
      },
      {
        "id": 2204,
        "timestamp": "2023-10-13T17:27:30.102Z",
        "accountEmail": "help@pressable.com",
        "ipAddress": "199.199.244.41",
        "userAgent": "PostmanRuntime/7.33.0",
        "name": "site.created",
        "description": "Site Created",
        "source": "api.v1",
        "message": "Created live site"
      }
    ],
    "page": {
      "currentPage": 1,
      "nextPage": 2,
      "lastPage": 7,
      "perPage": 5,
      "totalItems": 35
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Account Activity Log Actions

Retrieve a list of actions that you can use to filter account activity logs. Use the value in the 'name' field for filtering the logs.

The example response displays only a limited selection of actions. You can find the comprehensive list of actions in the actual API response.

curl --location --request GET 'https://my.pressable.com/v1/activity/account-actions' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz' \

{
    "message": "Success",
    "data": [
        {
            "name": "account.collaborator",
            "description": "Account Collaborator"
        },
        {
            "name": "banned",
            "description": "Banned"
        },
        {
            "name": "created",
            "description": "Created"
        },
        {
            "name": "dns",
            "description": "DNS Records Updated"
        }
    ],
    "errors": null
  }

Responses

Number

Message

Code

200

Success

Get List of Available Account Add-ons

Access a comprehensive list of add-ons available for your account. These add-ons offer the flexibility to enhance your plan with extra sites, increased site visits, and additional storage capacity. More details about upgrading your account can be found in our related knowledge base article.

curl --location --request GET 'https://my.pressable.com/v1/account/addons' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz' \

{
    "message": "Success",
    "data": [
        {
            "id": 1,
            "name": "1 Site",
            "unitAllocation": 1,
            "priceInCents": 1500
        },
        {
            "id": 4,
            "name": "5 Sites",
            "unitAllocation": 5,
            "priceInCents": 5000
        },
        {
            "id": 8,
            "name": "10 Sites",
            "unitAllocation": 10,
            "priceInCents": 7500
        },
        {
            "id": 11,
            "name": "100K Site Visits",
            "unitAllocation": 100000,
            "priceInCents": 8000
        },
        {
            "id": 12,
            "name": "Storage",
            "unitAllocation": 1,
            "priceInCents": 50
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get List of Add-ons Attached to Your Account

View the add-ons linked to your account that extend your plan with extra sites, more site visits, and increased storage capacity.

curl --location --request GET 'https://my.pressable.com/v1/account/addons/attached' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz' \

{
    "message": "Success",
    "data": [
        {
            "name": "1 Site",
            "quantity": 1
        },
        {
            "name": "10K Site Visits",
            "quantity": 1
        },
        {
            "name": "10GB Site Storage",
            "quantity": 1
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Update Add-ons Attached to Your Account

To modify the add-ons associated with your account, you need to submit a JSON object that includes the add-on's ID and the desired quantity. For instance, if you wish to change the quantity of a Site add-on with an ID of 1 to 5, you should send the following JSON object:

{ "addon_id": 1, "quantity": 5 }

Note: The quantity should reflect the total desired amount, not the increment you wish to add. For example, if you aim to increase your current quantity of 10 by 5, you should send a quantity of 15.

curl --location --request PUT 'https://my.pressable.com/v1/account/addons' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz' \
--header 'Content-Type: application/json' \
--data-raw '{
  "addon_id": 1,
  "quantity": 5
}'

Parameters

Add-on ID

addon_id (required)

(body)

Quantity (total desired amount)

quantity (required)

(body)

{
    "message": "Success",
    "data": [
        {
            "name": "1 Site",
            "quantity": 5
        },
        {
            "name": "10K Site Visits",
            "quantity": 5
        },
        {
            "name": "10GB Site Storage",
            "quantity": 5
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Collaborators

Get a list of collaborators. This will return all the collaborators that are attached to your sites, plus any instances of you being a collaborator on a site.

curl --location --request GET 'https://my.pressable.com/v1/collaborators' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw'

Parameters

No parameters

{
  "message": "Success",
  "data": [
    {
        "id": 4,
        "created": "2021-10-15T15:13:08.000Z",
        "updated": "2021-10-15T15:13:08.000Z",
        "accountId": 1,
        "email": "tomdoe@pressable.dev",
        "siteId": 1223013,
        "state": "active",
        "wpUsername": "tomdoe@pressable.dev",
        "name": "Tom Doe",
        "siteName": "my-presssable-net",
        "roles": [
            "download_backups",
            "manage_dns",
            "manage_git",
            "manage_notes",
            "manage_performance",
            "reset_collaborator_password",
            "restore_site",
            "sftp_access",
            "update_site_custom_name",
            "update_site_php_version",
            "update_site_wordpress_version",
            "execute_bulk_operations",
            "wp_access"
        ]
    },
    {
        "id": 757,
        "created": "2022-01-31T20:05:39.000Z",
        "updated": "2022-01-31T20:05:39.000Z",
        "accountId": 5,
        "email": "clairedoe@pressable.dev",
        "siteId": 14,
        "state": "active",
        "wpUsername": "clairedoe@pressable.dev",
        "name": "Claire Doe",
        "siteName": "jittery-crib-4894d78ee4",
        "roles": [
            "download_backups",
            "manage_dns",
            "manage_git",
            "manage_notes",
            "execute_bulk_operations",
            "manage_performance",
            "reset_collaborator_password",
            "restore_site",
            "sftp_access",
            "update_site_custom_name",
            "update_site_php_version",
            "update_site_wordpress_version",
            "execute_bulk_operations",
            "wp_access"
        ]
    },
  ],
  "errors": null
}

Responses

Number

Message

Code

200

Success

Get Collaborator

Get collaborator information for the specified collaborator.

curl --location --request GET 'https://my.pressable.com/v1/collaborators/{id}' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw'

Parameters

ID of the collaborator to get

id (required)

integer

{
  "message": "Success",
  "data": {
    "id": 757,
    "created": "2023-05-12T21:43:31.000Z",
    "updated": "2023-05-12T21:43:31.000Z",
    "accountId": 1419361,
    "email": "clairedoe@pressable.dev",
    "siteId": 1268,
    "state": "active",
    "wpUsername": "clairedoe@pressable.dev",
    "name": "clairedoe@pressable.dev",
    "siteName": "mynewsite",
    "roles": [
      "download_backups",
      "manage_dns",
      "manage_git",
      "manage_notes",
      "execute_bulk_operations",
      "manage_performance",
      "php_my_admin_access",
      "restore_site",
      "sftp_access",
      "update_site_custom_name",
      "update_site_php_version",
      "update_site_wordpress_version",
      "wp_access"
    ]
  },
  "errors": null
}

Responses

Number

Message

Code

200

Success

Update Account Level Access

Adds or removes account level access to a collaborator with the given email address. Account level access allows a collaborator to be added to all new sites created under the site's owner, the collaborator will be automatically added with the permissions send as part of the request.

Additionally, account level access can allow the collaborator to create sites on behalf of the account owner.

This endpoint requires an API Application with the owner scope.

Email (required)

This email will be used to find or create an account under Pressable.
The previous account will be set up as an account level collaborator for the owner of the API Application being used to send requests to Pressable's API
If the collaborator account is new, it will receive an email invite. The notification may reach the junk/spam folder.

Add To All New

Must be a boolean value.
Whether the collaborator should be added to new sites created under the API Application's owner account.
This does not affect previously created sites in any way. If you want to add this collaborator to previously created sites, please use the batch_create endpoint

Create Site

Must be a boolean value.
Whether the collaborator will have the capability of creating sites under the API Application's owner account.
Please be aware, If this value is true, add_to_all_new will be forced to true regardless of the value being sent on that parameter.

Roles

Roles must be an array of strings.
These roles will be assigned to the collaborator everytime is automatically added to a new site created under the API Application's owner account.
Accepted values are the following:

clone_site
convert_site
create_collaborator
delete_collaborator
delete_site
disable_site
download_backups
enable_site
execute_bulk_operations
manage_dns
manage_git
manage_notes
manage_performance
manage_wordpress
php_my_admin_access
plugin_management_access
reset_collaborator_password
restore_site
sftp_access
update_site_custom_name
update_site_php_version
update_site_wordpress_version
wp_access

If both add_to_all_new and create_site are set to false, the collaborator won't have account_level collaboration access to the API Application's owner account anymore. However, this action won't remove the collaborator from sites where it was previously attached. If you want to remove the user from previously attached sites, please use the batch_destroy endpoint

curl --location --request PUT 'https://my.pressable.com/v1/collaborators/update-account-level-access' \
--header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8DnJskv4' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "johndoe@pressable.dev",
  "add_to_all_new": true,
  "create_site": true,
  "roles": [
   "clone_site", "update_site_custom_name"
  ]
}'

Parameters

Data used to create the collaborators

data (required)

(body)

Responses

{
    "message": "Success",
    "data": {
        "email": "johndoe@pressable.dev",
        "add_to_all_new": true,
        "create_site": true
    },
    "errors": null
}

Number

Message

Code

200

Accepted

Bulk Create / Update

Adds a collaborator with the given a email address to a list of sites. If a collaborator already exists for a given site, the permissions will be updated with the new values provided.

Email (required)

This email will be used to create a new account under Pressable, and set it up as a collaborator for the sites identified by Site Ids.
This email will receive a notification after the process is finished. The notification may reach the junk/spam folder.

Site IDs (required)

Site Ids must be an array of integer numbers.
If the array includes the -1 value, this operation will be executed across all sites that the requester owns, or where it has create_collaborator permissions

Roles

Roles can be an array of strings.
Accepted values are the following:

clone_site
convert_site
create_collaborator
delete_collaborator
delete_site
disable_site
download_backups
enable_site
execute_bulk_operations
manage_dns
manage_git
manage_notes
manage_performance
manage_wordpress
php_my_admin_access
plugin_management_access
reset_collaborator_password
restore_site
sftp_access
update_site_custom_name
update_site_php_version
update_site_wordpress_version
wp_access

Collaborators with the create_collaborator role can add other collaborators with all permissions. They can also update other collaborator's permissions.
If wp_access is removed during a mass update action, Pressable will attempt to delete the WordPress user with this collaborator's email for the given sites. Posts credited to this user will be reassigned to the next available WordPress admin.

curl --location --request POST 'https://my.pressable.com/v1/collaborators/batch_create' \
--header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8DnJskv4' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "johndoe@pressable.dev",
  "siteIds": [
    2, 100, 500
  ],
  "roles": [
   "clone_site", "update_site_custom_name"
  ]
}'

Parameters

Data used to create the collaborators

data (required)

(body)

Responses

{
    "message": "Collaborator creation scheduled for 2 sites",
    "data": null,
    "errors": null
}

Number

Message

Code

200

Accepted

Bulk Delete

Removes a collaborator with the provided email address from a list of sites.

Email (required)

This email will be used to identify the collaborator you want to remove from the sites identified by Site Ids.

Site IDs (required)

Site Ids must be an array of integer numbers.
If the array includes the -1 value, this operation will be executed across all sites owned by the user.

Delete WP User

Delete WP User must be a boolean.
Defaults to false
If true, Pressable will attempt to delete the WordPress user that matches this collaborator's email.
If the WordPress user in question owns any post, authorship will get reassigned to the oldest WordPress admin available.

curl --location --request POST 'https://my.pressable.com/v1/collaborators/batch_destroy' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "clairedoe@pressable.dev",
  "delete_wp_user": true,
  "siteIds": [
    10, 20, 50
  ]
}'

Parameters

Data used to destroy the collaborators

data (required)

(body)

{
    "message": "Collaborator removal scheduled for 3 sites",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Accepted

Get Site

Get a specific site that belongs to the specified collaborator.

curl --location --request GET 'https://my.pressable.com/v1/collaborators/{collaborator_id}/site' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw'

Parameters

ID of the collaborator

collaborator_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2022-01-31T20:05:30.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 3,
        "displayName": "pressable.com",
        "domainsCount": 1,
        "ecommerce": false,
        "favorite": false,
        "ipAddress": "199.16.172.38",
        "ipAddressOne": "199.16.172.38",
        "ipAddressTwo": "199.16.173.236",
        "name": "my-presssable-net",
        "state": "live",
        "url": "pressable.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "tags": []
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Add Site Tag

Create tags for a collaborator on their site.

Tag Names (array)(required)

Tags allow you to add context to your sites and you can use them to define what your sites are related to.

curl --location --request POST 'https://my.pressable.com/v1/collaborators/{collaborator_id}/site/tags' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tag_names": [
    "paper", "plastic"
  ]
}'

Parameters

ID of the collaborator

collaborator_id (required)

integer

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2022-01-31T20:05:30.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 3,
        "displayName": "pressable.com",
        "domainsCount": 1,
        "ecommerce": false,
        "favorite": false,
        "ipAddress": "199.16.172.38",
        "ipAddressOne": "199.16.172.38",
        "ipAddressTwo": "199.16.173.236",
        "name": "my-presssable-net",
        "state": "live",
        "url": "pressable.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "tags": [
            {
                "id": 2601,
                "name": "paper"
            },
            {
                "id": 2602,
                "name": "plastic"
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Delete Site Tag

Delete site tags with the specified site tag ids on a site for a collaborator.

curl --location --request DELETE 'https://my.pressable.com/v1/collaborators/{collaborator_id}/site/tags' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tag_ids": [
    2601, 2602
  ]
}'

Parameters

ID of the collaborator

collaborator_id (required)

integer

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2022-01-31T20:05:30.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 3,
        "displayName": "pressable.com",
        "domainsCount": 1,
        "ecommerce": false,
        "favorite": false,
        "ipAddress": "199.16.172.38",
        "ipAddressOne": "199.16.172.38",
        "ipAddressTwo": "199.16.173.236",
        "name": "my-presssable-net",
        "state": "live",
        "url": "pressable.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "tags": []
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Site List using Email Address

Get a list of all sites that are attached to a Collaborator using the collaborator's email address. All sites information returned are from the collaborator's perspective. If the site is favorited by the collaborator favorite will be set to true, if the collaborator has added tags to sites then their site tags will be in the response.

URL encode the email address in the URL

user.name+tag+sorting@example.com => user.name%2Btag%2Bsorting%40example.com
user@example.com => user%40example.com
user/name@example.com => user%2Fname%40example.com

v1/collaborators/user%2Fname%40example.com/sites

curl --location --request GET 'https://my.pressable.com/v1/collaborators/{email_address}/sites' \
-- header 'Content-Type: application/json' \
--header 'Authorization: Bearer cdtcCU9RTo_WhgW2_ik7I22' \
--data '{
  "tag_name": "fish",
  "per_page": 20,
  "page": 1
}'

Parameters

Email address used to get all sites for collaborator

email_address (required)

string

(path)

Tag name for filtering site list

tag_name

(query)

Number of sites per page. Max number of sites per page is 50

per_page

(query)

The page for the request

page

(query)

{
    "message": "Success",
    "data": {
        "name": "Claire Doe",
        "email": "clairedoe@pressable.dev",
        "sites": [
            {
                "id": 1,
                "created": "2022-01-31T20:05:30.000Z",
                "accountId": 2,
                "clonedFromId": null,
                "collaboratorsCount": 3,
                "displayName": "pressable.com",
                "domainsCount": 1,
                "ecommerce": false,
                "favorite": false,
                "ipAddresses": [
                    "199.16.172.38",
                    "199.16.173.236"
                ],
                "name": "my-presssable-net",
                "state": "live",
                "url": "pressable.com",
                "staging": false,
                "sftpDomain": "sftp.pressable.com",
                "phpVersion": "8.2",
                "tags": []
            },
            {
                "id": 4,
                "created": "2022-01-31T20:05:30.000Z",
                "accountId": 2,
                "clonedFromId": null,
                "collaboratorsCount": 1,
                "displayName": "four",
                "domainsCount": 0,
                "ecommerce": false,
                "favorite": false,
                "ipAddresses": [
                    "199.16.172.123",
                    "199.16.173.175"
                ],
                "name": "four",
                "state": "live",
                "url": "four.mystagingwebsite.com",
                "staging": true,
                "sftpDomain": "sftp.pressable.com",
                "phpVersion": "8.2",
                "tags": []
            }
        ]
    },
    "page": {
        "currentPage": 1,
        "nextPage": 2,
        "lastPage": 65,
        "perPage": 20,
        "totalItems": 1297
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get Site using Email Address

Get a site attached to a collaborator.

curl --location --request GET 'https://my.pressable.com/v1/collaborators/{email_address}/sites/{site_id}' \
--header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw'

Parameters

Email address used for collaborator

email_address (required)

string

(path)

Site Id for site being requested

site_id (required)

integer

(path)

{
    "message": "Success",
    "data": {
        "name": "Claire Doe",
        "email": "clairedoe@pressable.dev",
        "sites": [
            {
                "id": 1,
                "created": "2022-01-31T20:05:30.000Z",
                "accountId": 2,
                "clonedFromId": null,
                "collaboratorsCount": 3,
                "displayName": "pressable.com",
                "domainsCount": 1,
                "ecommerce": false,
                "favorite": false,
                "ipAddresses": [
                    "199.16.172.38",
                    "199.16.173.236"
                ],
                "name": "my-presssable-net",
                "state": "live",
                "url": "pressable.com",
                "staging": false,
                "sftpDomain": "sftp.pressable.com",
                "phpVersion": "8.2",
                "tags": []
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Add Site as Favorite

Add a site to collaborator site favorites. Favorite sites show up first in collaborator site listings.

curl --location --request POST 'https://my.pressable.com/v1/collaborators/{email_address}/sites/{site_id}/favorite' \
--header 'Authorization: Bearer 9m11x6zrCUe7SKMME2dKjF4DrUGHTS8CC6rk-z1_P_M'

Parameters

Email address used for collaborator

email_address (required)

string

(path)

Site Id for site to be favorited

site_id (required)

integer

(path)

{
    "message": "Success",
    "data": {
        "name": "Claire Doe",
        "email": "clairedoe@pressable.dev",
        "sites": [
            {
                "id": 1,
                "created": "2022-01-31T20:05:30.000Z",
                "accountId": 2,
                "clonedFromId": null,
                "collaboratorsCount": 3,
                "displayName": "pressable.com",
                "domainsCount": 1,
                "ecommerce": false,
                "favorite": true,
                "ipAddresses": [
                    "199.16.172.38",
                    "199.16.173.236"
                ],
                "name": "my-presssable-net",
                "state": "live",
                "url": "pressable.com",
                "staging": false,
                "sftpDomain": "sftp.pressable.com",
                "phpVersion": "8.2",
                "tags": []
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Remove Site as Favorite

Remove a site from a collaborators list of site favorites.

curl --location --request DELETE 'https://my.pressable.com/v1/collaborators/{email_address}/sites/{site_id}/favorite' \
--header 'Authorization: Bearer 9m11x6zrCUe7SKMME2dKjF4DrUGHTS8CC6rk-z1_P_M'

Parameters

Email address used for collaborator

email_address (required)

string

(path)

Site Id for site to be removed as favorite

site_id (required)

integer

(path)

{
    "message": "Success",
    "data": {
        "name": "Claire Doe",
        "email": "clairedoe@pressable.dev",
        "sites": [
            {
                "id": 1,
                "created": "2022-01-31T20:05:30.000Z",
                "accountId": 2,
                "clonedFromId": null,
                "collaboratorsCount": 3,
                "displayName": "pressable.com",
                "domainsCount": 1,
                "ecommerce": false,
                "favorite": false,
                "ipAddresses": [
                    "199.16.172.38",
                    "199.16.173.236"
                ],
                "name": "my-presssable-net",
                "state": "live",
                "url": "pressable.com",
                "staging": false,
                "sftpDomain": "sftp.pressable.com",
                "phpVersion": "8.2",
                "tags": []
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Add Site Tag using Email Address

Add tags to a collaborator’s site using the collaborator's email address.

Tag Names (array)(required)

Tags allow you to add context to your sites for a collaborator and can be used to define what the site is related to.

curl --location --request POST 'https://my.pressable.com/v1/collaborators/{email_address}/sites/{site_id}/tag' \
--header 'Authorization: Bearer 9m11x6zrCUe7SKMME2dKjF4DrUGHTS8CC6rk-z1_P_M' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tag_names": [
    "paper", "plastic"
  ]
}'

Parameters

Email address used for collaborator

email_address (required)

string

(path)

Site Id for site to be favorited

site_id (required)

integer

(path)

Name of the tag to add to the site

data (required)

(body)

{
    "message": "Success",
    "data": {
        "name": "Claire Doe",
        "email": "clairedoe@pressable.dev",
        "sites": [
            {
                "id": 1,
                "created": "2022-01-31T20:05:30.000Z",
                "accountId": 2,
                "clonedFromId": null,
                "collaboratorsCount": 3,
                "displayName": "pressable.com",
                "domainsCount": 1,
                "ecommerce": false,
                "favorite": false,
                "ipAddresses": [
                    "199.16.172.38",
                    "199.16.173.236"
                ],
                "name": "my-presssable-net",
                "state": "live",
                "url": "pressable.com",
                "staging": false,
                "sftpDomain": "sftp.pressable.com",
                "phpVersion": "8.2",
                "tags": [
                    {
                        "id": 2603,
                        "name": "paper"
                    },
                    {
                        "id": 2604,
                        "name": "plastic"
                    }
                ]
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Remove Site Tag using Email Address

Remove tags from collaborator’s site using collaborator's email address.

Tag IDs (array)(required)

curl --location --request DELETE 'https://my.pressable.com/v1/collaborators/{email_address}/sites/{site_id}/tag' \
--header 'Authorization: Bearer 9m11x6zrCUe7SKMME2dKjF4DrUGHTS8CC6rk-z1_P_M' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tag_ids": [
        2603, 2604
    ]
}'

Parameters

Email address used for collaborator

email_address (required)

string

(path)

Site Id for site to be favorited

site_id (required)

integer

(path)

ID(s) of the tags to remove (array)

data (required)

(body)

{
    "message": "Success",
    "data": {
        "name": "Claire Doe",
        "email": "clairedoe@pressable.dev",
        "sites": [
            {
                "id": 1,
                "created": "2022-01-31T20:05:30.000Z",
                "accountId": 2,
                "clonedFromId": null,
                "collaboratorsCount": 3,
                "displayName": "pressable.com",
                "domainsCount": 1,
                "ecommerce": false,
                "favorite": false,
                "ipAddresses": [
                    "199.16.172.38",
                    "199.16.173.236"
                ],
                "name": "my-presssable-net",
                "state": "live",
                "url": "pressable.com",
                "staging": false,
                "sftpDomain": "sftp.pressable.com",
                "phpVersion": "8.2",
                "tags": []
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

DNS

Manage DNS through the Pressable API.

Get Zones

Get the zones attached to your account.

Zones are used to attach additional DNS records to your account.

curl --location --request GET 'https://my.pressable.com/v1/zones' \
--header 'Authorization: Bearer ob9TDvE07rXgUpVVZdNCNWIUYCDVghy8dZr1u2gH-o4'

Parameters

No parameters

{
    "message": "Success",
    "data": [
        {
            "id": 1,
            "name": "pressable.dev",
            "created": "2022-01-31T20:05:45.000Z"
        },
        {
            "id": 5,
            "name": "apple.com",
            "created": "2022-02-02T17:10:32.000Z"
        },
        {
            "id": 6,
            "name": "newdomain.com",
            "created": "2022-02-18T16:49:40.000Z"
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get Zone Records

Returns all the DNS records attached to a zone.

curl --location --request GET 'https://my.pressable.com/v1/zones/{zone_id}/records' \
--header 'Authorization: Bearer ob9TDvE07rXgUpVVZdNCNWIUYCDVghy8dZr1u2gH-o4'

Parameters

ID of the zone

zone_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 6,
        "created": "2022-02-18T16:49:40.000Z",
        "updated": "2022-02-18T16:49:40.000Z",
        "name": "newdomain.com",
        "records": [
            {
                "id": 37,
                "zoneId": 6,
                "primary": false,
                "type": "A",
                "name": "www",
                "value": "199.16.172.38",
                "priority": null,
                "weight": null,
                "port": null,
                "ttl": 3600,
                "siteId": 1,
                "created": "2022-02-18T16:49:40.000Z"
            },
            {
                "id": 38,
                "zoneId": 6,
                "primary": false,
                "type": "A",
                "name": "www",
                "value": "199.16.173.236",
                "priority": null,
                "weight": null,
                "port": null,
                "ttl": 3600,
                "siteId": 1,
                "created": "2022-02-18T16:49:40.000Z"
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Create Zone Record

When creating a new DNS Record supply all the required fields so the DNS record is built correctly.

{
  type: string
  name: string
  value: string
  priority: integer
  weight: integer
  port: integer
  ttl: integer [Default: 3600]
  site_id: integer [A Records only]
}

Please see the record requirements below:

curl --location --request POST 'https://my.pressable.com/v1/zones/{zone_id}/records' \
--header 'Authorization: Bearer ob9TDvE07rXgUpVVZdNCNWIUYCDVghy8dZr1u2gH-o4' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "CNAME",
  "name": "newsite2",
  "value": "newsite2",
  "ttl": 0
}'

Parameters

ID of the zone for which the DNS record should be created

zone_id (required)

integer($int64)

(path)

Data used to create a new DNS record

data (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 6,
        "created": "2022-02-18T16:49:40.000Z",
        "updated": "2022-02-18T16:49:40.000Z",
        "name": "newdomain.com",
        "records": [
            {
                "id": 37,
                "zoneId": 6,
                "primary": false,
                "type": "A",
                "name": "www",
                "value": "199.16.172.38",
                "priority": null,
                "weight": null,
                "port": null,
                "ttl": 3600,
                "siteId": 1,
                "created": "2022-02-18T16:49:40.000Z"
            },
            {
                "id": 38,
                "zoneId": 6,
                "primary": false,
                "type": "A",
                "name": "www",
                "value": "199.16.173.236",
                "priority": null,
                "weight": null,
                "port": null,
                "ttl": 3600,
                "siteId": 1,
                "created": "2022-02-18T16:49:40.000Z"
            },
            {
                "id": 39,
                "zoneId": 6,
                "primary": false,
                "type": "CNAME",
                "name": "newsite2",
                "value": "newsite2.",
                "priority": null,
                "weight": null,
                "port": null,
                "ttl": 0,
                "siteId": null,
                "created": "2022-02-21T17:21:57.000Z"
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Created

Delete Record

Delete a DNS record from a zone.

curl --location --request DELETE 'https://my.pressable.com/v1/zones/{zone_id}/records/{id}' \
--header 'Authorization: Bearer ob9TDvE07rXgUpVVZdNCNWIUYCDVghy8dZr1u2gH-o4'

Parameters

ID of the Zone for which the record will be deleted

zone_id (required)

integer($int64)

(path)

ID of the DNS record that should be deleted

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 6,
        "created": "2022-02-18T16:49:40.000Z",
        "updated": "2022-02-18T16:49:40.000Z",
        "name": "newdomain.com",
        "records": [
            {
                "id": 37,
                "zoneId": 6,
                "primary": false,
                "type": "A",
                "name": "www",
                "value": "199.16.172.38",
                "priority": null,
                "weight": null,
                "port": null,
                "ttl": 3600,
                "siteId": 1,
                "created": "2022-02-18T16:49:40.000Z"
            },
            {
                "id": 39,
                "zoneId": 6,
                "primary": false,
                "type": "CNAME",
                "name": "newsite2",
                "value": "newsite2.",
                "priority": null,
                "weight": null,
                "port": null,
                "ttl": 0,
                "siteId": null,
                "created": "2022-02-21T17:21:57.000Z"
            }
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Deleted

Generate Email Provider Records

Generate all the email records for popular providers. The records will be attached to the requested zone.

Current providers and the name used to add them are:

gsuite- Google Workspace records
office365- Microsoft Office365 records
zoho- Zoho Corporation records
namecheap- Namecheap records
namecom- Name.com records
proton- Proton Technologies AG records

curl --location --request POST 'https://my.pressable.com/v1/zones/{zone_id}/providers' \
--header 'Authorization: Bearer ki1ssXMLyJ-NPv7nInwXA4-Z6vYK4_kPTw8jHqU0eZA' \
--header 'Content-Type: application/json' \
--data-raw '{
  "provider": "zoho"
}'

Parameters

ID of the zone

zone_id (required)

integer($int64)

(path)

Data used to create email provider records

data (required)

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Created

SSL Certificate Details

Returns the SSL certificate details for an A Record.

curl --location --request GET 'https://my.pressable.com/v1/zones/{zone_id}/records/{id}/ssl' \
--header 'Authorization: Bearer ki1ssXMLyJ-NPv7nInwXA4-Z6vYK4' \
--header 'Content-Type: application/json' \

Parameters

ID of the zone the A Record is attached to

zone_id (required)

integer($int64)

(path)

ID of the DNS A record that SSL details should be gathered for

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "force_ssl": "166",
        "acme_certificate_id": "6234",
        "validation_expiration": "2021-08-21 06:31:12",
        "authz_uri": "https://acme-v02.api.letsencrypt.org/acme/authz-v3/2169703",
        "options": [
            "ACME_OPT_HSTS_1Y",
            "ACME_OPT_REDIRECT_TO_HTTPS"
        ],
        "certificate_expiration_date": "2021-11-12 05:31:40",
        "broken_record": null,
        "broken_check": null
    },
    "errors": null
}

{
  "message": "Success",
  "data": {
    "broken_record": null,
    "broken_check": null
  },
  "errors": null
}

{
    "message": "Only A records are supported",
    "data": null,
    "errors": [
        "Only A records are supported"
    ]
}

{
    "message": "No information found",
    "data": null,
    "errors": [
        "No information found"
    ]
}

Responses

Number

Message

Code

200

Success

Code

400

Only A records are supported

Code

400

No information found

Retry SSL Certificate Provisioning

Forces a retry of SSL certificate provisioning of A Records. This is a way to make sure SSL for an A Record is reprovisioned if it is not working properly.

curl --location --request PUT 'https://my.pressable.com/v1/zones/{zone_id}/records/{id}/ssl' \
--header 'Authorization: Bearer ki1ssXMLyJ-NPv7nInwXA4-Z6vYK4' \
--header 'Content-Type: application/json' \

Parameters

ID of the zone the A Record is attached to

zone_id (required)

integer($int64)

(path)

ID of the DNS A record that SSL should be reprovisioned for

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

{
    "message": "There was a problem processing your request.",
    "data": null,
    "errors": [
        "SSL can only be retried on A records"
    ]
}

Responses

Number

Message

Code

200

Success

Code

400

There was a problem processing your request

Edge Cache

Edge caching is a method of storing website data closer to users, reducing latency and network traffic. It's crucial for faster content delivery and improved user experience, particularly for geographically dispersed users.

Edge Cache provides performance improvements, particularly to the Time to First Byte (TTFB), by serving page cache directly from the closest server available to a site’s visitors.

Edge Cache Status

Get the current status of the edge cache for your site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/edge-cache' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to get the edge cache status for.

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "active": true,
        "defensive_mode": {
            "active": true,
            "active_until": 1724951720
        }
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Toggle Edge Cache

The ability to toggle edge cache allows you to enable or disable caching of your site's content at edge locations.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/edge-cache' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to toggle the edge cache for.

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Purge Edge Cache

Purging edge cache allows you to remove stored content at edge locations, ensuring the delivery of updated or corrected content to users. This is critical when changes are made to your site that need to be reflected immediately.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/edge-cache' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to purge the edge cache for.

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Edge Cache Defensive Mode

This mode adds an extra layer of protection against spam bots and DDoS attacks. When enabled, it requires visitors' browsers to complete a small task before accessing the site, which helps block malicious traffic. Legitimate users might see a brief challenge page before they can proceed. Edge Cache must be enabled on the site to use this feature.

You can activate this feature for periods ranging from 30 minutes to 7 days, providing on-demand security as needed, using the duration parameter. To remove the challenge page, you can disable the feature by setting the duration to null, or by waiting for the specified time to elapse.

Valid values for the duration parameter are:

30-minutes for 30 minutes
45-minutes for 45 minutes
1-hour for 1 hour
2-hours for 2 hours
3-hours for 3 hours
4-hours for 4 hours
5-hours for 5 hours
6-hours for 6 hours
7-hours for 7 hours
8-hours for 8 hours
9-hours for 9 hours
10-hours for 10 hours
11-hours for 11 hours
12-hours for 12 hours
13-hours for 13 hours
14-hours for 14 hours
15-hours for 15 hours
16-hours for 16 hours
17-hours for 17 hours
18-hours for 18 hours
19-hours for 19 hours
20-hours for 20 hours
21-hours for 21 hours
22-hours for 22 hours
23-hours for 23 hours
1-day for 1 day
2-days for 2 days
3-days for 3 days
4-days for 4 days
5-days for 5 days
6-days for 6 days
7-days for 7 days

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/edge-cache/defensive-mode' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json' \
--data-raw '{
    "duration": "1-hour"
}'

Parameters

ID of the site to turn edge cache defensive mode on/off for.

id (required)

integer($int64)

(path)

duration of the edge cache defensive mode timeframe.

duration (optional)

string

(body)

{
    "message": "Success",
    "data": {
        "id": 500,
        "created": "2022-01-31T20:05:33.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 1,
        "displayName": "five hundred site",
        "domainsCount": 0,
        "ecommerce": false,
        "edgeCache": "enabled",
        "edgeCacheDefensiveMode": true,
        "edgeCacheDefensiveModeUntil": 1720625109,
        "favorite": false,
        "ipAddress": "79.127.25.163",
        "ipAddressOne": "79.127.25.163",
        "ipAddressTwo": "235.255.236.118",
        "name": "busy-nose-1d7f431a88",
        "state": "live",
        "url": "busy-nose-1d7f431a88.mystagingwebsite.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.0",
        "wordpressVersion": "Current Stable Release (6.2)",
        "tags": [
            {
                "id": 354,
                "name": "Clannad"
            }
        ],
        "wpEnvironmentType": "development",
        "lightWeight404": false
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Must-Use Plugins

Must-use plugins, commonly referred to as mu-plugins, reside in a designated directory within the content folder and are auto-activated across all sites in the installation. They remain invisible on the standard Plugins page in wp-admin but can be viewed under a distinct Must-Use section. To deactivate them, one must remove the plugin file from the mu-plugins directory, located at wp-content/mu-plugins. We only allow for a single PHP file to be installed. Please visit Must Use Plugin documentation for more information.

Kindly monitor the webhooks associated with mu-plugins to stay informed about installations, updates, or deletions.

Get Must-Use Plugin List

Get a list of your mu-plugins.

curl --location --request GET 'https://my.pressable.com/v1/mu-plugins' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 1,
    "per_page": 20
}'

Parameters

page - the page of results

page (optional)

(body)

per_page - the number of results per page (max: 50)

per_page (optional)

(body)

{
    "message": "Success",
    "data": [
        {
            "id": 2,
            "created": "2023-10-31T17:17:31.129Z",
            "existingSites": false,
            "futureSites": true,
            "path": "https://raw.githubusercontent.com/pressable/pressable-maintenance-mode/main/pressable-maintenance-mode.php",
            "slug": "pressable-maintenance-mode.php"
        },
        {
            "id": 4,
            "created": "2023-10-31T22:37:07.613Z",
            "existingSites": true,
            "futureSites": true,
            "path": "https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0",
            "slug": "mu-plugin.php"
        }
    ],
    "page": {
        "currentPage": 1,
        "nextPage": null,
        "lastPage": 1,
        "perPage": 20,
        "totalItems": 2
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get Must-Use Plugin

Get details about your mu-plugin.

curl --location --request GET 'https://my.pressable.com/v1/mu-plugins/{id}' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

id - id of the mu plugin

id (required)

(path)

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2023-10-31T17:17:31.129Z",
        "existingSites": false,
        "futureSites": true,
        "path": "https://raw.githubusercontent.com/pressable/pressable-maintenance-mode/main/pressable-maintenance-mode.php",
        "slug": "pressable-maintenance-mode.php"
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Create / Install Must-Use Plugin

When a request is made to this endpoint with the mu-plugin details, we will install the plugin in the default mu-plugin directory of all of your sites, based on your requested settings of existing_sites and future_sites on mu-plugin creation.

Note: The slug of the mu-plugin will be the last part of the path, so if the path is https://raw.githubusercontent.com/pressable/pressable-maintenance-mode/main/pressable-maintenance-mode.php, the slug will be pressable-maintenance-mode.php

All of the following parameters are required.

path: the public url to where your mu-plugin is hosted, must be a single PHP (.php) file. Customers have had success using Github raw and Dropbox public URLs, like the following examples:
- https://raw.githubusercontent.com/pressable/pressable-maintenance-mode/main/pressable-maintenance-mode.php
- https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0
existing_sites: set as true if you want the mu-plugin to be installed on all existing sites.
future_sites: set as true if you want the mu-plugin to be installed on all future sites.

curl --location --request POST 'https://my.pressable.com/v1/mu-plugins' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json' \
--data-raw '{
    "path": "https://raw.githubusercontent.com/pressable/pressable-maintenance-mode/main/pressable-maintenance-mode.php",
    "existing_sites": false,
    "future_sites": true
}'

Parameters

path - the path to the mu-plugin

path (required)

(body)

existing_sites - set as true if you want the mu-plugin to be installed on all existing sites

existing_sites (required)

(body)

future_sites - set as true if you want the mu-plugin to be installed on all future sites

future_sites (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2023-01-31T20:05:30.000Z",
        "existing_sites": false,
        "future_sites": true,
        "path": "https://raw.githubusercontent.com/pressable/pressable-maintenance-mode/main/pressable-maintenance-mode.php",
        "slug": "pressable-maintenance-mode.php"
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Update Must-Use Plugin

This action will refresh the mu-plugin identified by the given ID across all sites in your account, incorporating any modifications from the specified path. If you have relocated your mu-plugin to a different path, you will need to delete the plugin associated with the previous path and create a new one using the updated path.

curl --location --request PUT 'https://my.pressable.com/v1/mu-plugins/{id}' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

id - the id of the mu-plugin to update

id (required)

(path)

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2023-01-31T20:05:30.000Z",
        "existing_sites": false,
        "future_sites": true,
        "path": "https://raw.githubusercontent.com/pressable/pressable-maintenance-mode/main/pressable-maintenance-mode.php",
        "slug": "pressable-maintenance-mode.php"
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Delete Must-Use Plugin

This action will delete the mu-plugin identified by the given ID and remove it from all sites in your account.

curl --location --request DELETE 'https://my.pressable.com/v1/mu-plugins/{id}' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

id - the id of the mu-plugin to delete

id (required)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

On-Demand Backups

Create your own backups of your site's filesystem and database.

You are limited to 3 on-demand filesystem backups and 3 on-demand database backups. If you reach the limit, you'll need to delete one before you can create a new one. On-demand backups are automatically deleted after 30 days for the latest backup taken and 7 days for the oldest backup taken.

On-Demand Backup List

Get a list of on-demand backups for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/ondemand-backups' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to get on-demand backups for

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
        {
            "id": "50564",
            "siteId": 50,
            "completed": 1682954943,
            "status": "completed",
            "type": "db",
            "bytes": "9278",
            "requested": 1682954869,
            "backupTimestamp": "2023-05-01 15:29:03",
            "createdBy": "John Doe (user@user.com)",
            "removedIn": "29 days and 21 hours from now",
            "deleteAt": 1685546944
        },
        {
            "id": "505641",
            "siteId": 50,
            "completed": 1682954884,
            "status": "completed",
            "type": "db",
            "bytes": "92786",
            "requested": 1682954863,
            "backupTimestamp": "2023-05-01 15:28:04",
            "createdBy": "John Doe (user@user.com)",
            "removedIn": "6 days and 21 hours from now",
            "deleteAt": 1683559744
        },
        {
            "id": "5053",
            "siteId": 50,
            "completed": 1682954644,
            "status": "completed",
            "type": "fs",
            "bytes": "846297",
            "requested": 1682954625,
            "backupTimestamp": "2023-05-01 15:24:04",
            "createdBy": "John Doe (user@user.com)",
            "removedIn": "6 days and 22 hours from now",
            "deleteAt": 1683562925
        }
    ],
    "errors": null
}

Create On-Demand Backup

Create an on-demand backup for the specified site.

You are limited to 3 on-demand filesystem backups and 3 on-demand database backups. If you reach the limit, you'll need to delete one before you can create a new one.

Note: The response body will not return a backup ID until the backup has completed. We will provide a requestId. You can use the on-demand backups creation webhook to know when the backup has completed.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/ondemand-backups' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json' \
--data '{
    "backup_type": "fs"
}'

Parameters

ID of the site to create the on-demand backup for

id (required)

integer($int64)

(path)

Backup Type (fs or db) of the on-demand backup to create

backup_type (fs or db) (required)

string

(body)

{
    "message": "Success",
    "data": {
        "id": null,
        "requestId": 50564,
        "siteId": 1223013,
        "completed": null,
        "status": "creating",
        "type": "fs",
        "bytes": null,
        "requested": 1682966700,
        "backupTimestamp": null,
        "createdBy": "John Doe (user@user.com)",
        "removedIn": "30 days and 0 hours from now",
        "deleteAt": 1685558700
    },
    "errors": null
}

Get On-Demand Backup

Get the details for a specific on-demand backup attached to the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/ondemand-backups/{id}' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to get on-demand backup for

site_id (required)

integer($int64)

(path)

ID of the on-demand backup attached to the site

id (required)

string

(path)

{
    "message": "Success",
    "data": {
        "id": "50564",
        "siteId": 50,
        "completed": 1682954943,
        "status": "completed",
        "type": "db",
        "bytes": "9278",
        "requested": 1682954869,
        "backupTimestamp": "2023-05-01 15:29:03",
        "createdBy": "John Doe (user@user.com)",
        "removedIn": "29 days and 21 hours from now",
        "deleteAt": 1685546944
    },
    "errors": null
}

Download On-Demand Backup

Download the specified on-demand backup attached to the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/ondemand-backups/{id}/download' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to get on-demand backup for

site_id (required)

integer($int64)

(path)

ID of the on-demand backup attached to the site to be downloaded

id (required)

string

(path)

{
  "message": "string",
  "errors": [
    "string"
  ]
}

Responses

Number

Message

Code

200

Bzipped tar archive of filesystem backup or SQL text backup of database backup

Delete On-Demand Backup

Delete a specific on-demand backup attached to the specified site. The status of the site is set to `deleting` and the backup is removed from the site.

Note: This action is irreversible. The backup cannot be restored once it is deleted. You can monitor the on-demand backup deleted webhook to get notified when the backup is deleted.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/ondemand-backups/{id}' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to delete the on-demand backup for

site_id (required)

integer($int64)

(path)

ID of the on-demand backup to be removed from the site

id (required)

string

(path)

{
    "message": "Success",
    "data": {
        "id": "50564",
        "siteId": 50,
        "completed": 1682954943,
        "status": "deleting",
        "type": "db",
        "bytes": "9278",
        "requested": 1682954869,
        "backupTimestamp": "2023-05-01 15:29:03",
        "createdBy": "John Doe (user@user.com)",
        "removedIn": "29 days and 21 hours from now",
        "deleteAt": 1685546944
    },
    "errors": null
}

Plugins

Plugins are powerful extensions for WordPress sites that enhance functionality and enable customizations. These modular add-ons allow users to seamlessly integrate new features, such as contact forms, social media integration, SEO optimization, and more, without the need for extensive coding knowledge.

With these API endpoints, you can manage plugins for your sites.

Plugin List

Get a list of plugins for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/plugins' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to get plugins for

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
          {
            "name": "akismet",
            "title": "Akismet Anti-Spam",
            "description": "Used by millions, Akismet is quite possibly the best way in the world to protect your blog from spam.",
            "status": "active",
            "update": "none",
            "version": "5.1",
            "update_version": null
          },
          {
            "name": "jetpack",
            "title": "Jetpack",
            "description": "Security, performance, and marketing tools made by WordPress experts.",
            "status": "active",
            "update": "version higher than expected",
            "version": "12.2-a.9",
            "update_version": null
          },
          {
            "name": "jetpack-protect",
            "title": "Jetpack Protect",
            "description": "Security tools that keep your site safe and sound, from posts to plugins.",
            "status": "active",
            "update": "none",
            "version": "1.4.0",
            "update_version": null
          },
          {
            "name": "pressable-onepress-login",
            "title": "Pressable OnePress Login",
            "description": "Pressable OnePress Login for the MyPressable Control Panel.",
            "status": "active",
            "update": "none",
            "version": "1.3.1",
            "update_version": null
          },
          {
            "name": "quiz-maker",
            "title": "Quiz Maker",
            "description": "This plugin allows you make unlimited number of quizes.",
            "status": "active",
            "update": "available",
            "version": "6.4.2.7",
            "update_version": "6.4.3.1"
          },
          {
            "name": "advanced-cache.php",
            "title": "",
            "description": "Advanced caching plugin.",
            "status": "dropin",
            "update": "none",
            "version": "",
            "update_version": null
          },
          {
            "name": "object-cache.php",
            "title": "Memcached",
            "description": "External object cache.",
            "status": "dropin",
            "update": "none",
            "version": "",
            "update_version": null
          }
    ],
    "errors": null
}

Install and Activate Plugins

To enhance your WordPress site, install and activate plugins to add new features, functionality, and customization options effortlessly.

This endpoint installs and activates a plugin for the specified site. Job Queues are used to install and activate the plugins. Please use our Plugin related Webhooks to know if the plugin was installed and activated successfully.

Plugins can be installed from the WordPress plugin repository or from a custom URL.

To install a plugin from the WordPress plugin repository, use the plugin name (slug). If a slug is used the WordPress API is used to determine if the plugin slug is valid. To install a plugin from a custom URL, use the HTTPS URL to the plugin zip file.

The plugin version is an optional parameter. If not specified, the latest version of the plugin will be installed.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/plugins' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "plugins": [
        {
            "path": "google-analytics-for-wordpress"
        },
        {
            "path": "wpforms-lite",
            "version": "1.8.0.2"
        },
        {
            "path": "https://github.com/pressable/pressable-maintenance-mode/archive/refs/tags/v1.0.4.zip"
        }
    ]
}'

Parameters

ID of the site to install and activate plugins for

id (required)

integer($int64)

(path)

Array of plugin objects to install and activate with their version and path details

plugins (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Update Plugins

Regularly updating plugins is crucial for WordPress sites to ensure optimal performance, security, and compatibility with the latest features and enhancements.

This endpoint updates plugins for the specified site. Job Queues are used to update the plugins. Please use our Plugin related Webhooks to know if the plugin was updated successfully.

Plugins are updated using the plugin name (slug).

The plugin version is an optional parameter. If not specified, the plugin will be updated to the latest version.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/plugins' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "plugins": [
        {
            "path": "google-analytics-for-wordpress"
        },
        {
            "path": "wpforms-lite",
            "version": "1.8.1.2"
        }
    ]
}'

Parameters

ID of the site to update the plugins for

id (required)

integer($int64)

(path)

Array of plugin objects to update with their version and path details

plugins (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Deactivate Plugins

Deactivating plugins on WordPress sites allows for troubleshooting, prevents conflicts, and temporarily disables specific functionalities without removing the plugin entirely.

This endpoint deactivates plugins for the specified site. Job Queues are used to deactivate the plugins. Please use our Plugin related Webhooks to know if the plugin was deactivated successfully.

Plugins are deactivated using the plugin name (slug).

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/plugins/deactivate' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "plugins": [
        {
            "path": "google-analytics-for-wordpress"
        },
        {
            "path": "wpforms-lite"
        }
    ]
}'

Parameters

ID of the site to deactivate the plugins for

id (required)

integer($int64)

(path)

Array of plugin objects to deactivate with their path details

plugins (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Activate Plugins

Activating previously deactivated plugins restores desired functionalities, expands features, and re-enables customizations.

This endpoint activates plugins for the specified site. Job Queues are used to activate the plugins. Please use our Plugin related Webhooks to know if the plugin was activated successfully.

Plugins are activated using the plugin name (slug).

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/plugins/activate' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "plugins": [
        {
            "path": "google-analytics-for-wordpress"
        },
        {
            "path": "wpforms-lite"
        }
    ]
}'

Parameters

ID of the site to activate the plugins for

id (required)

integer($int64)

(path)

Array of plugin objects to activate with their path details

plugins (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Delete Plugins

Deleting unnecessary plugins from WordPress sites enhances performance, reduces security risks, and minimizes conflicts, resulting in a streamlined and efficient website environment.

This endpoint deletes plugins for the specified site. Job Queues are used to delete the plugins. Please use our Plugin related Webhooks to know if the plugin was deleted successfully.

Plugins are deleted using the plugin name (slug).

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/plugins' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "plugins": [
        {
            "path": "google-analytics-for-wordpress"
        },
        {
            "path": "wpforms-lite"
        }
    ]
}'

Parameters

ID of the site to delete the plugins for

id (required)

integer($int64)

(path)

Array of plugin objects to delete with their path details

plugins (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Security Alerts

Stay informed about security alerts for your WordPress sites. Our system detects vulnerabilities in your themes and plugins, helping you identify risks that may need updates or fixes across all your sites.

Best ways to keep your sites safe:

Regularly check for security issues
Update plugins and themes promptly on all sites
Use our Plugin Management Schedules to automate updates and save time.

Note: Scans for new vulnerabilities run automatically each week.

Plugin Alerts

Get a list of plugins reporting security issues

The response is grouped by plugin status: active, active-network, drop-ins, inactive, must-use

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/security-alerts/plugins' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to get plugins reporting security issues for

id (required)

integer($int64)

(path)

{
  "message": "Success",
  "data": {
    "active": [
      {
        "id": 1126,
        "site_id": 4,
        "name": "redirection",
        "version": "1.1",
        "status": "active",
        "active": true,
        "update_available": false,
        "update_version": null,
        "security_risk": true,
        "security_alerts": [
          {
            "title": "Redirection <= 3.6.2 - Cross-Site Request Forgery (CSRF)",
            "description": "The Redirection WordPress plugin was affected by a Cross-Site Request Forgery (CSRF) security vulnerability.",
            "severity": null,
            "fixed_in": "3.6.3",
            "reference_urls": [
              "https://www.ripstech.com/php-security-calendar-2018/",
              "https://plugins.trac.wordpress.org/changeset/1974375/redirection"
            ]
          },
          {
            "title": "Redirection < 2.8 - Authenticated Local File Inclusion",
            "description": "The Redirection WordPress plugin was affected by an Authenticated Local File Inclusion security vulnerability.",
            "severity": null,
            "fixed_in": "2.8",
            "reference_urls": [
              "https://advisories.dxw.com/advisories/ace-file-inclusion-redirection/",
              "https://seclists.org/fulldisclosure/2018/Jun/29"
            ]
          },
          {
            "title": "Redirection 2.3.3 - view/admin/item.php URL Handling Reflected XSS",
            "description": "The Redirection WordPress plugin was affected by a view/admin/item.php URL Handling Reflected XSS security vulnerability.",
            "severity": null,
            "fixed_in": "2.3.4",
            "reference_urls": [

            ]
          },
          {
            "title": "Redirection - view/admin/log_item.php Non-existent Posts Referer HTTP Header XSS",
            "description": "The Redirection WordPress plugin was affected by a view/admin/log_item.php Non-existent Posts Referer HTTP Header XSS security vulnerability.",
            "severity": null,
            "fixed_in": "2.2.10",
            "reference_urls": [

            ]
          },
          {
            "title": "Redirection - wp-admin/tools.php id Parameter XSS",
            "description": "The Redirection WordPress plugin was affected by a wp-admin/tools.php id Parameter XSS security vulnerability.",
            "severity": "medium",
            "fixed_in": "2.2.9",
            "reference_urls": [

            ]
          },
          {
            "title": "Redirection < 2.2.12 - XSS",
            "description": "The Redirection WordPress plugin was affected by a XSS security vulnerability.",
            "severity": "medium",
            "fixed_in": "2.2.12",
            "reference_urls": [

            ]
          }
        ]
      }
    ],
    "must-use": [
      {
        "id": 717,
        "site_id": 4,
        "name": "wordfence",
        "version": "1.0",
        "status": "must-use",
        "active": false,
        "update_available": true,
        "update_version": "6.9.8",
        "security_risk": true,
        "security_alerts": [
          {
            "title": "Wordfence < 7.6.1 - Admin+ Stored Cross-Site Scripting",
            "description": "The plugin does not sanitise and escape a settings, which could allow high privilege users such as admin to perform Stored Cross-Site Scripting attacks even when the unfiltered_html capability is disallowed (for example in multisite setup)",
            "severity": "low",
            "fixed_in": "7.6.1",
            "reference_urls": [

            ]
          },
          {
            "title": "Wordfence < 7.1.14 - Username Enumeration Prevention Bypass",
            "description": "The plugin protection against user enumeration (ie ?author=id) could be bypassed by using an array as author parameter",
            "severity": "medium",
            "fixed_in": "7.1.14",
            "reference_urls": [
              "http://www.waraxe.us/advisory-109.html",
              "https://packetstormsecurity.com/files/149845/"
            ]
          },
          {
            "title": "Wordfence <= 5.1.4 - Cross-Site Scripting (XSS)",
            "description": "An attacker can inject arbitrary script via the vulnerable query string parameter val of the whois.php file.",
            "severity": "medium",
            "fixed_in": "5.1.5",
            "reference_urls": [

            ]
          },
          {
            "title": "Wordfence 5.2.2 - XSS in Referer Header",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by a XSS in Referer Header security vulnerability.",
            "severity": null,
            "fixed_in": "5.2.3",
            "reference_urls": [
              "https://vexatioustendencies.com/wordpress-plugin-vulnerability-dump-part-2/"
            ]
          },
          {
            "title": "Wordfence <= 5.2.4 - Multiple Vulnerabilities (XSS & Bypasses)",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by a Multiple Vulnerabilities (XSS & Bypasses) security vulnerability.",
            "severity": null,
            "fixed_in": "5.2.5",
            "reference_urls": [
              "https://secupress.me/blog/wordfence-5-2-5-security-update/",
              "https://www.securityfocus.com/bid/70915/"
            ]
          },
          {
            "title": "Wordfence 5.2.3 - Multiple Vulnerabilities",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by a Multiple Vulnerabilities security vulnerability.",
            "severity": null,
            "fixed_in": "5.2.4",
            "reference_urls": [
              "https://vexatioustendencies.com/wordfence-v5-2-3-2-stored-xss-insufficient-logging-throttle-bypass-exploit-detection-bypass/"
            ]
          },
          {
            "title": "Wordfence 5.2.3 - Banned IP Functionality Bypass",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by a Banned IP Functionality Bypass security vulnerability.",
            "severity": null,
            "fixed_in": "5.2.4",
            "reference_urls": [
              "https://packetstormsecurity.com/files/128259/",
              "https://seclists.org/fulldisclosure/2014/Sep/49",
              "https://vexatioustendencies.com/wordfence-v5-2-3-2-stored-xss-insufficient-logging-throttle-bypass-exploit-detection-bypass/"
            ]
          },
          {
            "title": "Wordfence 5.2.4 - IPTraf.php URI Request Stored XSS",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by an IPTraf.php URI Request Stored XSS security vulnerability.",
            "severity": null,
            "fixed_in": "5.2.5",
            "reference_urls": [
              "https://packetstormsecurity.com/files/128259/"
            ]
          },
          {
            "title": "Wordfence 5.2.4 - Unspecified Issue",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by an Unspecified Issue security vulnerability.",
            "severity": null,
            "fixed_in": "5.2.5",
            "reference_urls": [

            ]
          },
          {
            "title": "Wordfence 3.8.1 - wp-admin/admin.php whois Parameter Stored XSS",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by a wp-admin/admin.php whois Parameter Stored XSS security vulnerability.",
            "severity": null,
            "fixed_in": "3.8.3",
            "reference_urls": [
              "https://packetstormsecurity.com/files/122993/",
              "https://www.securityfocus.com/bid/62053/"
            ]
          },
          {
            "title": "Wordfence 3.3.5 - XSS & IAA",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by a XSS & IAA security vulnerability.",
            "severity": null,
            "fixed_in": "3.3.7",
            "reference_urls": [
              "https://seclists.org/fulldisclosure/2012/Oct/139"
            ]
          },
          {
            "title": "Wordfence 3.8.6 - lib/IPTraf.php User-Agent Header Stored XSS",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by a lib/IPTraf.php User-Agent Header Stored XSS security vulnerability.",
            "severity": null,
            "fixed_in": "3.8.7",
            "reference_urls": [

            ]
          },
          {
            "title": "Wordfence 3.8.1 - Password Creation Restriction Bypass",
            "description": "The Wordfence Security – Firewall & Malware Scan WordPress plugin was affected by a Password Creation Restriction Bypass security vulnerability.",
            "severity": null,
            "fixed_in": "3.8.3",
            "reference_urls": [

            ]
          }
        ]
      }
    ]
  },
  "errors": null
}

Theme Alerts

Get a list of themes reporting security issues

The response is grouped by theme status: active, inactive, parent

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/security-alerts/themes' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to get themes reporting security issues for

id (required)

integer($int64)

(path)

{
  "message": "Success",
  "data": {
    "active": [
      {
        "id": 62,
        "site_id": 495,
        "name": "Divi",
        "version": "4.15.1",
        "status": "active",
        "active": true,
        "update_available": false,
        "update_version": null,
        "security_risk": true,
        "security_alerts": [
          {
            "title": "Divi < 4.25.2 - Contributor+ Stored XSS",
            "description": "The theme is vulnerable to Stored Cross-Site Scripting due to insufficient input sanitization and output escaping. This makes it possible for authenticated attackers, with Author-level access and above, to inject arbitrary web scripts in pages that will execute whenever a user accesses an injected page.",
            "severity": "medium",
            "fixed_in": "4.25.2",
            "reference_urls": [
              "https://www.wordfence.com/threat-intel/vulnerabilities/id/6571a899-f217-434f-bbed-b1faf77a8d8b"
            ]
          },
          {
            "title": "Elegant Themes Divi Theme, Extra Theme, Divi Page Builder <= 4.25.0 - Authenticated (Contributor+) DOM-Based Stored Cross-Site Scripting",
            "description": "The Elegant Themes Divi theme, Extra theme, and Divi Page Builder plugin for WordPress are vulnerable to DOM-Based Stored Cross-Site Scripting via the ‘title’ parameter in versions up to, and including, 4.25.0 due to insufficient input sanitization and output escaping. This makes it possible for authenticated attackers, with contributor-level permissions and above, to inject arbitrary web scripts in pages that will execute whenever a user accesses an injected page.",
            "severity": "medium",
            "fixed_in": "4.25.1",
            "reference_urls": [
              "https://www.wordfence.com/threat-intel/vulnerabilities/id/efac70f6-d959-41f7-bdef-d554f1c9133e"
            ]
          },
          {
            "title": "Divi < 4.23.2 - Authenticated (Contributor+) Stored Cross-Site Scripting via Shortcode",
            "description": "The Divi theme for WordPress is vulnerable to Stored Cross-Site Scripting via the plugin's 'et_pb_text' shortcode in all versions up to, and including, 4.23.1 due to insufficient input sanitization and output escaping on user supplied custom field data. This makes it possible for authenticated attackers, with contributor-level access and above, to inject arbitrary web scripts in pages that will execute whenever a user accesses an injected page.",
            "severity": "medium",
            "fixed_in": "4.23.2",
            "reference_urls": [
              "https://www.wordfence.com/threat-intel/vulnerabilities/id/999475c5-5f17-47fa-a0d0-47cb5a8a0eb4"
            ]
          },
          {
            "title": "Divi < 4.20.3 - Contributor+ Stored XSS",
            "description": "The theme does not validate and escape some parameters, which could allow users with the contributor role and above to perform Stored Cross-Site Scripting attacks",
            "severity": "medium",
            "fixed_in": "4.20.3",
            "reference_urls": [

            ]
          }
        ]
      }
    ]
  },
  "errors": null
}

Sites

Site List

Get a list of sites belonging to your account. Sites can be filtered by tag name. Site listing is a full list of sites attached to your account, unless pagination is requested.

Request a paginated response by sending "paginate" set to true in the query parameters. Additional accepted parameters include "per_page" and "page".

per_page: the amount of sites returned in a response
page: the page of the response

When paginating, additional information will be placed in the response regarding paging information:

curl --location --request GET 'https://my.pressable.com/v1/sites' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paginate": true,
    "per_page": 1,
    "page": 2
}'

Parameters

Site tag name

tag_name

(query)

Request a paginated response

paginate

(query)

Number of sites per page. Max number of sites per page is 50

per_page

(query)

The page for the request

page

(query)

{
    "message": "Success",
    "data": [
        {
            "id": 1,
            "created": "2022-01-31T20:05:30.000Z",
            "accountId": 2,
            "clonedFromId": null,
            "collaboratorsCount": 3,
            "datacenterCode": "DFW",
            "datacenterName": "Dallas, TX, USA",
            "displayName": "pressable.com",
            "domainsCount": 1,
            "ecommerce": false,
            "edgeCache": "enabled",
            "edgeCacheDefensiveMode": false,
            "edgeCacheDefensiveModeUntil": nil,
            "favorite": false,
            "ipAddress": "199.16.172.38",
            "ipAddressOne": "199.16.172.38",
            "ipAddressTwo": "199.16.173.236",
            "name": "my-presssable-net",
            "state": "live",
            "url": "pressable.com",
            "staging": false,
            "sftpDomain": "sftp.pressable.com",
            "phpVersion": "8.2",
            "wordpressVersion": "Latest Release (Beta)",
            "tags": [
                {
                    "id": 1357,
                    "name": "Halo 3: ODST"
                }
            ],
            "wpEnvironmentType":"production",
            "lightWeight404": true,
            "multisiteSupport": false
        },
        {
            "id": 3,
            "created": "2022-01-31T20:05:30.000Z",
            "accountId": 2,
            "clonedFromId": null,
            "collaboratorsCount": 0,
            "datacenterCode": "DCA",
            "datacenterName": "Washington, DC, USA",
            "displayName": "zippykidnetworks-net",
            "domainsCount": 0,
            "ecommerce": false,
            "edgeCache": "enabled",
            "edgeCacheDefensiveMode": false,
            "edgeCacheDefensiveModeUntil": nil,
            "favorite": false,
            "ipAddress": "199.16.172.107",
            "ipAddressOne": "199.16.172.107",
            "ipAddressTwo": "199.16.173.153",
            "name": "zippykidnetworks-net",
            "state": "deploying",
            "url": "zippykidnetworks-net.mystagingwebsite.com",
            "staging": false,
            "sftpDomain": "sftp.pressable.com",
            "phpVersion": "8,2",
            "wordpressVersion": "Current Stable Release (6.2)",
            "tags": [],
            "wpEnvironmentType":"production",
            "lightWeight404": false,
            "multisiteSupport": false
        },
        {
            "id": 4,
            "created": "2022-01-31T20:05:30.000Z",
            "accountId": 2,
            "clonedFromId": null,
            "collaboratorsCount": 1,
            "datacenterCode": "N/A",
            "datacenterName": "N/A",
            "displayName": "four",
            "domainsCount": 0,
            "ecommerce": false,
            "edgeCache": "disabled",
            "edgeCacheDefensiveMode": false,
            "edgeCacheDefensiveModeUntil": nil,
            "favorite": false,
            "ipAddress": "199.16.172.123",
            "ipAddressOne": "199.16.172.123",
            "ipAddressTwo": "199.16.173.175",
            "name": "four",
            "state": "live",
            "url": "four.mystagingwebsite.com",
            "staging": true,
            "sftpDomain": "sftp.pressable.com",
            "phpVersion": "8,2",
            "wordpressVersion": "Current Stable Release (6.2)",
            "tags": [
                {
                    "id": 744,
                    "name": "Super Mario Bros. 3"
                }
            ],
            "wpEnvironmentType":"staging",
            "lightWeight404": false,
            "multisiteSupport": false
        }
    ],
    "page": {
        "currentPage": 1,
        "nextPage": 2,
        "lastPage": 66,
        "perPage": 20,
        "totalItems": 1309
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Create Site

Create a new site in your account.

Name (required)

Site name must be at least 4 characters
Periods, spaces, and other special characters are not permitted
Dashes are accepted, but name cannot start or end with a dash

PHP Version (optional)

Set your PHP Version to a valid value. If no version is set in the parameter a dafault PHP version will be used Valid PHP Versions: 8.1, 8.2, 8.3 or 8.4

Datacenter (optional)

Provide a datacenter code to create your site at a specific location.
Use the Datacenter endpoint to determine which datacenters you have access to
When not specifying a datacenter to use when creating a site a default datacenter will be used

Staging (optional)

A staging site can be used to test updates and changes before deploying those changes to your live site
Domains can not be added to a staging site
Valid values are either true or false
Default: false

Install (optional)

Use the install feature to install plugins that you have access to
Use the site-install-options to determine what install options you have access to
When not sending an install option when creating a site a default installation of WordPress in used

Multisite Support (optional)

Please note that you must be on a High Traffic Plan to use this feature.
Configure multisite support: If no value is specified for this parameter, it will automatically default to false.
When enabling multisite support, the API will automatically add define('WP_ALLOW_MULTISITE', true); to your wp-config.php file. It will also configure the COOKIE_DOMAIN setting to enable login functionality across different domains. This setup allows you to create and manage a network of multiple sites within a single WordPress installation.

Custom WP-Admin Username (optional)

It can contain alphabetical (a-z, A-Z) and numerical (0-9) characters.
Additionally, underscores (_) and hyphens (-) are allowed.
The username should be between 1 and 60 characters in length.

Custom WP-Admin Email (optional)

A valid email address begins with a series of alphanumeric characters and can incorporate various special characters like periods, exclamation points, or hash symbols.
It must contain an "@" symbol, succeeded by a domain name which can feature alphanumeric characters, hyphens, and a period to distinguish the domain and top-level domain (TLD).

Note: Utilizing a custom WP-Admin username requires providing a corresponding custom WP-Admin email address, and the same applies in reverse.

curl --location --request POST 'https://my.pressable.com/v1/sites' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "your-site-name",
  "php_version": "8.0",
  "staging": true,
  "install": "woocommerce",
  "multisite_support": "true",
  "datacenter_code": "DCA",
  "wp_admin_username": "yourusername",
  "wp_admin_email": "user@domain.com"
}'

Parameters

Data used to create a new site

data (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 1314,
        "created": "2022-02-17T20:50:05.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 0,
        "datacenterCode": "DCA",
        "datacenterName": "Washington, DC, USA",
        "displayName": "your-site-name",
        "domainsCount": 0,
        "ecommerce": false,
        "edgeCache": "disabled",
        "edgeCacheDefensiveMode": false,
        "edgeCacheDefensiveModeUntil": nil,
        "favorite": false,
        "ipAddress": "199.16.172.70",
        "ipAddressOne": "199.16.172.70",
        "ipAddressTwo": "199.16.173.246",
        "name": "your-site-name",
        "state": "deploying",
        "url": "your-site-name.mystagingwebsite.com",
        "staging": true,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": null,
        "wordpressVersion": "Current Stable Release (6.2)",
        "tags": [],
        "wpEnvironmentType": "production",
        "lightWeight404": false,
        "multisiteSupport": true
    },
    "errors": null
}

Responses

Number

Message

Code

201

Created

Validate Site Name

Use this endpoint to check if a site name is valid before attempting to create a site.

curl --location --request POST 'https://my.pressable.com/v1/sites/validate' \
--header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8'

Parameters

Name to validate

name (required)

string

(body)

{
    "message": "Site name is valid",
    "data": {
        "valid": true
    },
    "errors": null
}

{
    "message": "Site name has already been taken",
    "data": {
        "valid": false
    },
    "errors": null
}

{
    "message": "Site name is not formatted correctly. Periods, spaces, and other special characters are not permitted in site names. Dashes are fine, but name cannot start or end with a dash. Name must be at least 3 characters in length",
    "data": {
        "valid": false
    },
    "errors": null
}

Responses

Number

Message

Code

200

Site name is valid

Code

200

Site name has already been taken

Code

200

Site name is not formatted correctly. Periods, spaces, and other special characters are not permitted in site names. Dashes are fine, but name cannot start or end with a dash. Name must be at least 3 characters in length

Get Site

Get site information and settings.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh'

Parameters

ID of the site to get

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2022-01-31T20:05:30.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "datacenterCode": "DFW",
        "datacenterName": "Dallas, TX, USA",
        "displayName": "pressable.com",
        "ecommerce": false,
        "edgeCache": "disabled",
        "edgeCacheDefensiveMode": false,
        "edgeCacheDefensiveModeUntil": nil,
        "favorite": false,
        "ipAddress": "199.16.172.38",
        "ipAddressOne": "199.16.172.38",
        "ipAddressTwo": "199.16.173.236",
        "name": "my-presssable-net",
        "pageViews": {
            "allTime": {
                "people": 0,
                "views": 0
            },
            "lastTwoYearsIsAllTime": {
                "people": 0,
                "views": 0
            },
            "currentMonth": {
                "people": 0,
                "views": 0
            },
            "lastMonth": {
                "views": 0,
                "people": 0
            },
            "today": {
                "people": 0,
                "views": 0
            },
            "twoMonthsAgo": {
                "views": 0,
                "people": 0
            },
            "yesterday": {
                "people": 0,
                "views": 0
            }
        },
        "phpVersion": "8.2",
        "wordpressVersion": "Current Stable Release (6.2)",
        "sftpDomain": "sftp.pressable.com",
        "state": "live",
        "url": "pressable.com",
        "wordpressLoginUrl": "pressable.com/wp-admin",
        "staging": false,
        "tags": [
            {
                "id": 1357,
                "name": "Halo 3: ODST"
            }
        ],
        "wpEnvironmentType":"development",
        "collaborators": [
            {
                "id": 1,
                "created": "2022-01-31T20:05:39.000Z",
                "email": "janedoe@pressable.dev",
                "gravatar": "https://www.gravatar.com/avatar/eabc66b353b56eba0b94ff5695fbcfbf?d=mp",
                "name": "Jane Doe",
                "wpUsername": "jane",
                "username": "46e652f73b2afc"
            },
            {
                "id": 2,
                "created": "2022-01-31T20:05:39.000Z",
                "email": "tomdoe@pressable.dev",
                "gravatar": "https://www.gravatar.com/avatar/127a526b67c878d70961db95ae87fa56?d=mp",
                "name": "Tom Doe",
                "wpUsername": "tom",
                "username": "6f4c70e32926e2"
            },
            {
                "id": 1203,
                "created": "2022-01-31T20:05:39.000Z",
                "email": "clairedoe@pressable.dev",
                "gravatar": "https://www.gravatar.com/avatar/595f525cba4a637978bc1ab2899f1d52?d=mp",
                "name": "Claire Doe",
                "wpUsername": "johndoe",
                "username": null
            }
        ],
        "jetpack": null
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Update Site

Update the Display Name, PHP Version or WP Environment Type for a site.

Display Name

Do you have a confusing display name for your site? You can update your site's display name to make things easier for you to keep track of.

PHP Version

Update your site's PHP Version. Valid PHP Versions: 8.1, 8.2, 8.3 or 8.4

WP Environment Type

Update your site's environment type. After making the request, please give the system a bit of time to make the change. It will be added to the job queue and processed as soon as possible.
Valid WP Environment Types: local, development, staging or production

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}' \
--header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8Dn' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Five Hundred Site",
  "php_version": "8.0",
  "wp_environment_type": "development"
}'

Parameters

Update Site Details

data (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 500,
        "created": "2022-01-31T20:05:33.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 1,
        "displayName": "five hundred site",
        "domainsCount": 0,
        "ecommerce": false,
        "edgeCache": "disabled",
        "edgeCacheDefensiveMode": false,
        "edgeCacheDefensiveModeUntil": nil,
        "favorite": false,
        "ipAddress": "79.127.25.163",
        "ipAddressOne": "79.127.25.163",
        "ipAddressTwo": "235.255.236.118",
        "name": "busy-nose-1d7f431a88",
        "state": "live",
        "url": "busy-nose-1d7f431a88.mystagingwebsite.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.0",
        "wordpressVersion": "Current Stable Release (6.2)",
        "tags": [
            {
                "id": 354,
                "name": "Clannad"
            }
        ],
        "wpEnvironmentType": "development",
        "lightWeight404": false,
        "multisiteSupport": false
    },
    "errors": null
}

Responses

Number

Message

Code

200

Updated Site Details

Delete Site

Delete a site with the specified id.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}' \
--header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8Dn'

Parameters

ID of the site to delete

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Search Sites

Search for sites linked to your account by using our approved keys for filtering. Provide the filters as an array of key-value pairs within the 'filters' parameter.

key: The property you want to filter by.
value: The value you want to match for the provided property.

Valid Filter Keys

domain
name
state
wordpress_version
php_version
datacenter_code

Note: At least one filter must be provided in the request in order to get a response. The response will include pagination information.

Additional accepted parameters include “per_page” and "page".

per_page: the amount of sites returned in a response
page: the page of the response

curl --location --request POST 'https://my.pressable.com/v1/sites/search' \
--header 'Authorization: Bearer zftCxjbICWZE8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json' \
--data-raw '{
  "filters": [
    {
      "key": "name",
      "value": "zippy"
    },
    {
      "key": "state",
      "value": "deploying"
    }
  ],
  "per_page": 1,
  "page": 2
}'

Parameters

Array to refine your search based on various properties

filters (required)

array

(body)

Site property being searched

key

string

(body)

Value of the site property being searched

value

string

(body)

Page

page

integer

(body)

Per Page

per_page

integer

(body)

{
    "message": "Success",
    "data": [
        {
            "id": 3,
            "name": "zippykidnetworks-net",
            "displayName": "zippykidnetworks-net",
            "url": "zippykidnetworks-net.mystagingwebsite.com",
            "created": "2023-07-05T18:10:15.000Z",
            "clonedFromId": null,
            "datacenterCode": "DCA",
            "datacenterName": "Washington, DC, USA",
            "ecommerce": false,
            "edgeCache": "enabled",
            "edgeCacheDefensiveMode": true,
            "edgeCacheDefensiveModeUntil": 1720625109,
            "ipAddresses": [
                "199.16.172.107",
                "199.16.173.153"
            ],
            "lightWeight404": false,
            "phpVersion": null,
            "sftpDomain": "sftp.pressable.com",
            "staging": false,
            "state": "deploying",
            "wordpressVersion": "Current Stable Version (6.3)",
            "wpEnvironmentType": "production",
            "multisiteSupport": false
        }
    ],
    "page": {
        "currentPage": 1,
        "nextPage": null,
        "lastPage": 1,
        "perPage": 20,
        "totalItems": 1
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Site Install Options

When creating a new site you can select for certain options available to be installed, such as woocommerce. This endpoint will return an array of install options available to you. When not sending an install option when creating a site a default installation of WordPress in used.

curl --location --request GET 'https://my.pressable.com/v1/sites/install-options' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

No parameters

{
    "message": "Success",
    "data": [
        "wordpress",
        "woocommerce"
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Available install options

Available Site Datacenters

When creating a new site you can select for a certain datacenter that is available to be used. Use the datacenter code when creating a site. This endpoint will return a collection of datacenter options available to you. When not specifying a datacenter to use when creating a site a default datacenter will be used.

curl --location --request GET 'https://my.pressable.com/v1/sites/datacenters' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3434'

Parameters

No parameters

{
    "message": "Success",
    "data": [
        {
            "code": "BUR",
            "name": "Los Angeles, CA, USA"
        },
        {
            "code": "DCA",
            "name": "Washington, DC, USA"
        },
        {
            "code": "DFW",
            "name": "Dallas, TX, USA"
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Available datacenter options

Valid PHP Versions

Get valid PHP versions that are currently available for sites hosted within our platform.

curl --location --request GET 'https://my.pressable.com/v1/sites/php-versions' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34'

Parameters

No parameters

{
    "message": "Success",
    "data": ["8.1", "8.2", "8.3", "8.4"],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Disable Site

When disabling a site the site will be put in a suspended state and all requests to the site will receive a 480 Temporarily Unavailable response. The disabled site will still count towards your site billing count.

This endpoint only works for API Applications with account owner permission.

More information:https://pressable.com/knowledgebase/disabling-a-site

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/disable' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3434'

Parameters

ID of the site to be disabled

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 500,
        "created": "2022-01-31T20:05:33.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 1,
        "datacenterCode": "N/A",
        "datacenterName": "N/A",
        "displayName": "five hundred site",
        "domainsCount": 0,
        "ecommerce": false,
        "edgeCache": "enabled",
        "edgeCacheDefensiveMode": true,
        "edgeCacheDefensiveModeUntil": 1720625109,
        "favorite": false,
        "ipAddress": "79.127.25.163",
        "ipAddressOne": "79.127.25.163",
        "ipAddressTwo": "235.255.236.118",
        "name": "busy-nose-1d7f431a88",
        "state": "disabled",
        "url": "busy-nose-1d7f431a88.mystagingwebsite.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "wordpressVersion": "Current Stable Release (6.2)",
        "tags": [
            {
                "id": 354,
                "name": "Clannad"
            }
        ],
        "wpEnvironmentType": "development",
        "lightWeight404": false,
        "multisiteSupport": false
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Enable Site

This only works for sites that are currently disabled. Enabling a site returns the site to a live state allowing for normal html responses, removing the 480 Temporarily Unavailable response for users.

This endpoint only works for API Applications with account owner permission.

More information:https://pressable.com/knowledgebase/disabling-a-site

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/enable' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34'

Parameters

ID of the site to be enabled

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 500,
        "created": "2022-01-31T20:05:33.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 1,
        "datacenterCode": "N/A",
        "datacenterName": "N/A",
        "displayName": "five hundred site",
        "domainsCount": 0,
        "ecommerce": false,
        "edgeCache": "disabled",
        "edgeCacheDefensiveMode": false,
        "edgeCacheDefensiveModeUntil": nil,
        "favorite": false,
        "ipAddress": "79.127.25.163",
        "ipAddressOne": "79.127.25.163",
        "ipAddressTwo": "235.255.236.118",
        "name": "busy-nose-1d7f431a88",
        "state": "live",
        "url": "busy-nose-1d7f431a88.mystagingwebsite.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "wordpressVersion": "Current Stable Release (6.2)",
        "tags": [
            {
                "id": 354,
                "name": "Clannad"
            }
        ],
        "wpEnvironmentType": "development",
        "lightWeight404": false,
        "multisiteSupport": false
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Convert Site (Staging/Live)

Staging to Live

Converting a staging site to a live site will add the site to your billable sites, also giving you the ability to add domains to the site.

Live to Staging

Before converting a live site to a staging site verify you have removed all attached DNS records. Converting to a staging site will remove your ability to add DNS records to the site, as well as, remove the site from your billable sites.

This endpoint only works for API Applications with account owner permission.

More information:https://pressable.com/knowledgebase/how-sites-staging-websites-and-website-clones-work-at-pressable/#converting-sites

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/convert' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34'

Parameters

ID of the site to be converted

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 500,
        "created": "2022-01-31T20:05:33.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "datacenterCode": "N/A",
        "datacenterName": "N/A",
        "displayName": "five hundred site",
        "ecommerce": false,
        "edgeCache": "disabled",
        "edgeCacheDefensiveMode": false,
        "edgeCacheDefensiveModeUntil": nil,
        "favorite": false,
        "ipAddress": "79.127.25.163",
        "ipAddressOne": "79.127.25.163",
        "ipAddressTwo": "235.255.236.118",
        "name": "busy-nose-1d7f431a88",
        "pageViews": {
            "allTime": {
                "people": 0,
                "views": 0
            },
            "currentMonth": {
                "people": 0,
                "views": 0
            },
            "lastMonth": {
                "views": 0,
                "people": 0
            },
            "today": {
                "people": 0,
                "views": 0
            },
            "twoMonthsAgo": {
                "views": 0,
                "people": 0
            },
            "yesterday": {
                "people": 0,
                "views": 0
            }
        },
        "phpVersion": "8.2",
        "wordpressVersion": "Current Stable Release (6.2)",
        "sftpDomain": "sftp.pressable.com",
        "state": "live",
        "url": "busy-nose-1d7f431a88.mystagingwebsite.com",
        "wordpressLoginUrl": "busy-nose-1d7f431a88.mystagingwebsite.com/wp-admin",
        "staging": true,
        "tags": [
            {
                "id": 354,
                "name": "Clannad"
            }
        ],
        "wpEnvironmentType": "staging",
        "collaborators": [
            {
                "id": 484,
                "created": "2022-01-31T20:05:39.000Z",
                "email": "clairedoe@pressable.dev",
                "gravatar": "https://www.gravatar.com/avatar/595f525cba4a637978bc1ab2899f1d52?d=mp",
                "name": "Claire Doe",
                "wpUsername": "johndoe",
                "username": null
            }
        ],
        "jetpack": null
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Clear CDN Cache

Clear the CDN cache for a site with the specified id.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/cache' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34347g'

Parameters

ID of the site for which to clear the CDN cache

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get CDN Status

Get the CDN status for a site with the specified id. The status can be either enabled or disabled.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/cdn' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site for which to clear the CDN cache

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "cdnEnabled": true
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Enable CDN

Enable the CDN for a site with the specified id.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/cdn' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site for which to enable the CDN

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "cdnEnabled": true
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Disable CDN

Disable the CDN for a site with the specified id.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/cdn' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site for which to disable the CDN

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "cdnEnabled": false
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Toggle CDN

Enable or Disable the CDN for a site with the specified id.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/cdn' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site for which to enable or disable the CDN

id (required)

integer($int64)

(path)

{
  "message": "Success",
  "data": {
      "cdnEnabled": true
  },
  "errors": null
}

Responses

Number

Message

Code

200

Success

Flush Object Cache

Flush the object cache for a site with the specified id.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/object-cache' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site for which to flush the object cache

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Toggle Light Weight 404

Enable or Disable Light Weight 404 handling for a site with the specified id.

If enabled, requests trying to fetch a non-existing static file will receive a light weight 404 response generated by Pressable.

If disabled, requests trying to fetch a non-existing static file will be handled by your WordPress server.

Please note that this applies to requests trying to fetch files with extensions:

.css .gif .eot .jpg .jpeg .js .otf .png .svg .swf .ttf .webm .webp .woff .woff2

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/light_weight_404' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site for which to enable or disable the Light Weight 404 handler

id (required)

integer($int64)

(path)

{
  "message": "Success",
  "data": {
      "lightWeight404Enabled": true
  },
  "errors": null
}

Responses

Number

Message

Code

200

Success

Toggle Multisite Support

Please note that you must be on a High Traffic Plan to use this feature.

Enable, or Disable, Domain Multisite Support for a site with the specified id.

When enabling multisite support, the system will automatically add define('WP_ALLOW_MULTISITE', true); to your wp-config.php file. It will also configure the COOKIE_DOMAIN setting to enable login functionality across different domains. This setup allows you to create and manage a network of multiple sites within a single WordPress installation.

When multisite support is disabled, the WP_ALLOW_MULTISITE and COOKIE_DOMAIN constants are removed from the site’s wp-config.php file. After disabling, please check your site to ensure it is still functioning correctly, as you may need to update or remove additional settings from your wp-config.php file.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/multisite-support' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site for which to enable or disable Multisite Support

id (required)

integer($int64)

(path)

{
  "message": "Success",
  "data": {
      "id": 3,
      "created": "2024-05-02T22:50:25.000Z",
      "accountId": 2,
      "clonedFromId": null,
      "collaboratorsCount": 0,
      "datacenterCode": "DCA",
      "datacenterName": "Washington, DC, USA",
      "displayName": "zippykidnetworks-net",
      "domainsCount": 0,
      "ecommerce": false,
      "edgeCache": "disabled",
      "edgeCacheDefensiveMode": false,
      "edgeCacheDefensiveModeUntil": null,
      "favorite": false,
      "ipAddress": "199.16.172.107",
      "ipAddressOne": "199.16.172.107",
      "ipAddressTwo": "199.16.173.153",
      "name": "zippykidnetworks-net",
      "state": "deploying",
      "url": "zippykidnetworks-net.mystagingwebsite.com",
      "staging": false,
      "sftpDomain": "sftp.pressable.com",
      "phpVersion": "8.2",
      "wordpressVersion": "Current Stable Version (6.5)",
      "tags": [],
      "wpEnvironmentType": "development",
      "lightWeight404": false,
      "multisiteSupport": true
  },
  "errors": null
}

Responses

Number

Message

Code

200

Success

Maintenance Mode

The "Maintenance Mode" feature offers a toggle to either enable or disable a protective mode for your website. Enabling it activates the Pressable Maintenance Mode plugin, which ensures your WP Admin remains accessible to you while displaying a Maintenance Mode screen to your site's visitors, thus barring them from interaction while you perform any needed updates or adjustments behind the scenes. Conversely, disabling it makes your website fully accessible and interactive for visitors, so it is vital to ensure all updates and changes are finalized for a seamless user experience before deactivating this mode.

Note: After making the request, please give the system a bit of time to make the change. It will be added to the job queue and processed as soon as possible.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/maintenance-mode' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site for which to enable or disable the Maintenance Mode

id (required)

integer($int64)

(path)

{
  "message": "Success",
  "data": null,
  "errors": null
}

Responses

Number

Message

Code

200

Success

Favorite Site

Add a site to your site favorites, favorite sites show up first in site listings.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/favorites' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site to add as favorite

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Unfavorite Site

Remove a site as a favorite with the specified site id.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/favorites' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'

Parameters

ID of the site to remove as a favorite

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Create Site Clone

Create a copy of the specified site.

curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/clone' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "five-hundred-clone",
  "staging": true,
  "datacenter_code": "DCA"
}'

Parameters

ID of the site to clone

site_id (required)

integer($int64)

(path)

Data used to clone the site

data

(body)

{
    "message": "Success",
    "data": {
        "id": 1315,
        "created": "2022-02-17T21:48:03.000Z",
        "accountId": 2,
        "clonedFromId": 500,
        "collaboratorsCount": 0,
        "datacenterCode": "DCA",
        "datacenterName": "Washington, DC, USA",
        "displayName": "five-hundred-clone",
        "domainsCount": 0,
        "ecommerce": false,
        "edgeCache": "disabled",
        "edgeCacheDefensiveMode": false,
        "edgeCacheDefensiveModeUntil": nil,
        "favorite": false,
        "ipAddress": "199.16.172.247",
        "ipAddressOne": "199.16.172.247",
        "ipAddressTwo": "199.16.173.144",
        "name": "five-hundred-clone",
        "state": "cloning",
        "url": "five-hundred-clone.mystagingwebsite.com",
        "staging": true,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": null,
        "wordpressVersion": "Current Stable Release (6.2)",
        "tags": [],
        "wpEnvironmentType": "staging",
        "lightWeight404": false,
        "multisiteSupport": false
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Backups List

Get a list of available site backups for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/backups' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'

Parameters

ID of the site to which to get the backups

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
        {
            "timestamp": "2022-02-18-00-00",
            "siteId": 1,
            "databaseBackupId": 1234,
            "filesystemBackupId": 5678
        },
        {
            "timestamp": "2022-02-17-12-00",
            "siteId": 1,
            "databaseBackupId": 1234,
            "filesystemBackupId": 5678
        },
        {
            "timestamp": "2022-02-16-23-59",
            "siteId": 1,
            "databaseBackupId": 1234,
            "filesystemBackupId": 5678
        },
        {
            "timestamp": "2022-02-11-00-00",
            "siteId": 1,
            "databaseBackupId": 1234,
            "filesystemBackupId": null
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Filesystem Backups List

Get a list of available site filesystem backups for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/backups/fs' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'

Parameters

ID of the site to which to get the backups

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
        {
            "id": "4226768170",
            "site_id": 1,
            "backup_timestamp": "2022-11-30 00:00:00",
            "type": "fs",
            "title": "Wed, 30 Nov 2022 00:00:00 UTC (on-demand)",
            "formatted_timestamp": "2022-11-30T00:00:00.000Z"
        },
        {
            "id": "4220809902",
            "site_id": 1,
            "backup_timestamp": "2021-11-29 00:00:00",
            "type": "fs",
            "title": "Mon, 29 Nov 2021 00:00:00 UTC",
            "formatted_timestamp": "2021-11-29T00:00:00.000Z"
        },
        {
            "id": "4214903229",
            "site_id": 1,
            "backup_timestamp": "2021-11-28 00:00:00",
            "type": "fs",
            "title": "Sun, 28 Nov 2021 00:00:00 UTC",
            "formatted_timestamp": "2021-11-28T00:00:00.000Z"
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Database Backups List

Get a list of available site database backups for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/backups/db' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'

Parameters

ID of the site to which to get the backups

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
        {
            "id": "4070338267",
            "site_id": 1,
            "backup_timestamp": "2022-11-13 18:00:00",
            "type": "db",
            "title": "Sun, 13 Nov 2022 18:00:00 UTC (on-demand)",
            "formatted_timestamp": "2022-11-13T18:00:00.000Z"
        },
        {
            "id": "4070338267",
            "site_id": 1,
            "backup_timestamp": "2031-11-03 18:00:00",
            "type": "db",
            "title": "Mon, 03 Nov 2031 18:00:00 UTC",
            "formatted_timestamp": "2031-11-03T18:00:00.000Z"
        },
        {
            "id": "4069808072",
            "site_id": 1,
            "backup_timestamp": "2021-11-03 16:00:00",
            "type": "db",
            "title": "Wed, 03 Nov 2021 16:00:00 UTC",
            "formatted_timestamp": "2021-11-03T16:00:00.000Z"
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get Site Backup

Download a specified site backup

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/backups/{backup_id}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'

Parameters

ID of the site to which to get the backups

site_id (required)

integer($int64)

(path)

ID of the site backup to download

backup_id (required)

integer($int64)

(path)

Response Stream

Responses

Number

Message

Code

200

Bzipped tar archive of filesystem backup or SQL text backup of database backup

Site Filesystem & Database Restores

Restore your site from a Filesystem and/or Database backup. During a restore, your site will be set in maintenance mode and will be inaccessible for the duration of the restore. Depending on the size of your site, the restore can be as short as a few minutes to a few hours. Select a filesystem and/or database backup from the lists below to restore your website to a previous version backup list. You will receive an email when the restore attempt is finished.

Cross Site Restores

Want to restore to a different site in your account? Simply send the site id for the site you would like the restore placed on. We will replace the site with the backup options you requested.

restore_on_site_id (optional)

Warning: The restore process is irreversible and rolling back your database may cause loss of data.

curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/restores' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz' \
--header 'Content-Type: application/json' \
--data-raw '{
  "filesystem_id": 1234,
  "database_id": 5678,
  "restore_on_site_id": 45
}'

Parameters

ID of the site to which to get the backups

site_id (required)

integer($int64)

(path)

ID of the database backup

database_id (optional)

integer($int64)

body

ID of the filesystem backup

filesystem_id (optional)

integer($int64)

body

ID of the site for a Cross Site Restore

restore_on_site_id (optional)

integer($int64)

body

{
  "message": "Success",
  "data": null,
  "errors": null
}

Responses

Number

Message

Code

200

Success

Data Sync

Data Sync allows you to replace the filesystem and/or database on your chosen destination site with the data from your source site. However, be aware that this could potentially overwrite more recent transactions on the destination site. Before using this feature, decide on the type of sync you prefer - you can opt to sync:

theme files and directories [ themes_directory ]
plugin files and directories [ plugins_directory ]
media uploads directory - Syncing the entire database is required for files to appear in your Media Library [ uploads_directory ]
wp-content files and directories - Any files outside of themes, plugins, or uploads [ wp_content_directory ]
web root files and directories - Anything in the root directory excluding wp-content [root_directory ]
skip HTTP Status Check - The process will skip the HTTP Status Health Check of the destination site
database - The process will completely overwrite the database on the destination site [ database ]
WP Environment Type - Set the destination site's environment type [ wp_environment_type ]
- If not set, the value will be set to the destination site's current value.
- Valid WP Environment Types: local, development, staging or production

To sync the full filesystem simply set all the file and directory options to true.

Use this feature carefully to avoid loss of any important, recent data.

For each type of data you plan to sync you will need to ensure that on-demand backup slots are available for both the destination and source sites.

The destination site will be put into maintenance mode and will be inaccessible for the duration of the sync. Depending on the size of your site, the sync can be as short as a few minutes to a few hours.

Parameters

from_site_id (required) - this is your source site.
to_site_id (required) - this is your destination site.
themes_directory - true | false
plugins_directory - true | false
uploads_directory - true | false
wp_content_directory - true | false
root_directory - true | false
skip_http_check - true | false
database - true | false
wp_environment_type (optional) - Set the destination site's environment type. If not set, the value will be set to the destination site's current value. Valid WP Environment Types include local, development, staging or production

Warning: Use Data Sync with caution. The process will completely overwrite files and/or database on the destination site. For the protection of your sites, we will automatically take a backup of the source site and the destination site in case they need to be restored.

curl --location --request POST 'https://my.pressable.com/v1/sites/sync' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz' \
--header 'Content-Type: application/json' \
--data-raw '{
  "from_site_id": 1234,
  "to_site_id": 5678,
  "themes_directory": true,
  "plugins_directory": false,
  "uploads_directory": true,
  "wp_content_directory": true,
  "root_directory": false,
  "skip_http_check": false,
  "database": true,
  "wp_environment_type": "production"
}'

Parameters

ID of the source site

from_site_id (required)

integer($int64)

body

ID of the destination site

to_site_id (required)

integer($int64)

body

Sync theme files and directories

themes_directory (optional)

boolean

body

Sync plugin files and directories

plugins_directory (optional)

boolean

body

Sync media uploads files and directories

uploads_directory (optional)

boolean

body

Sync wp-content files and directories

wp_content_directory (optional)

boolean

body

Sync Web root files and directories

root_directory (optional)

boolean

body

Skip HTTP status check of destination site

skip_http_check (optional)

boolean

body

Sync Database

database (optional)

boolean

body

WP Environment Type

wp_environment_type (optional)

string

body

{
  "message": "Success",
  "data": null,
  "errors": null
}

Responses

Number

Message

Code

200

Success

Collaborator List

Get a list of collaborators for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/collaborators' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzv'

Parameters

ID of the site to which to get the collaborators

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
        {
            "id": 1,
            "created": "2022-01-31T20:05:39.000Z",
            "updated": "2022-01-31T20:05:39.000Z",
            "accountId": 3,
            "email": "janedoe@pressable.dev",
            "siteId": 1,
            "state": "active",
            "wpUsername": "jane",
            "name": "Jane Doe",
            "siteName": "my-presssable-net"
        },
        {
            "id": 2,
            "created": "2022-01-31T20:05:39.000Z",
            "updated": "2022-01-31T20:05:39.000Z",
            "accountId": 4,
            "email": "tomdoe@pressable.dev",
            "siteId": 1,
            "state": "active",
            "wpUsername": "tom",
            "name": "Tom Doe",
            "siteName": "my-presssable-net"
        },
        {
            "id": 1203,
            "created": "2022-01-31T20:05:39.000Z",
            "updated": "2022-01-31T20:05:39.000Z",
            "accountId": 5,
            "email": "clairedoe@pressable.dev",
            "siteId": 1,
            "state": "active",
            "wpUsername": "johndoe",
            "name": "Claire Doe",
            "siteName": "my-presssable-net"
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Create Site Collaborator

Create a new collaborator with the specified email on the specified site.

curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/collaborators' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "waynedoe@pressable.dev",
  "roles": [ "clone_site", "update_site_custom_name" ]
}'

Parameters

ID of the site to which to add the collaborator

site_id (required)

integer($int64)

(path)

Data used to create the collaborator

data (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 1303,
        "created": "2022-02-18T16:25:46.000Z",
        "updated": "2022-02-18T16:25:47.000Z",
        "accountId": 7,
        "email": "waynedoe@pressable.dev",
        "siteId": 1,
        "state": "active",
        "wpUsername": "waynedoe@pressable.dev",
        "name": "waynedoe@pressable.dev",
        "siteName": "my-presssable-net",
        "roles": [
            "clone_site",
            "update_site_custom_name"
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Created

Get Site Collaborator

Get site collaborator information.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/collaborators/{id}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzv'

Parameters

ID of the site to which to get the collaborator

site_id (required)

integer($int64)

(path)

ID of the collaborator to get

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 1303,
        "created": "2022-02-18T16:25:46.000Z",
        "updated": "2022-02-18T16:25:47.000Z",
        "accountId": 7,
        "email": "waynedoe@pressable.dev",
        "siteId": 1,
        "state": "active",
        "wpUsername": "waynedoe@pressable.dev",
        "name": "waynedoe@pressable.dev",
        "siteName": "my-presssable-net"
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Delete Collaborator

Delete a collaborator with the specified id.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/collaborators/{id}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--data '{
    "delete_wp_user": true
}'

Parameters

ID of the site to which to delete the collaborator

site_id (required)

integer($int64)

(path)

ID of the collaborator to delete

id (required)

integer($int64)

(path)

Whether to delete the corresponding WordPress user

delete_wp_user

boolean

(query)

Delete WP User must be a boolean.
Defaults to false
If true, Pressable will attempt to delete the WordPress user that matches this collaborator's email.
If the WordPress user in question owns any post, authorship will get reassigned to the oldest WordPress admin available.

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Set Collaborator WP-Admin Password

If one of your collaborators is unable to log into the site’s WordPress dashboard because of a forgotten, or unknown, password, this endpoint can be used to set their WP Admin password to a randomly generated value.

More information:https://pressable.com/knowledgebase/resetting-your-wp-admin-password

curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/collaborators/{id}/wp-password-reset' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site the collaborator belongs to

id (required)

integer($int64)

(path)

ID of the collaborator to reset the WP Admin password for

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": "!WGhilzTwgAItI!q_GcyhF_o",
    "errors": null
}

Responses

Number

Message

Code

200

Success

Domain List

Get a list of domains for a given site.

Note: Should you prefer to segregate the domain list by IP address, utilize the optional separate_records parameter and set its value to true. This enables you to view which domains are directed towards specific IP addresses, along with the precise domain ID for each individual record.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/domains' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site to which to get the domains

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
        {
            "id": 20,
            "created": "2022-02-02T17:02:51.000Z",
            "primary": true,
            "name": null,
            "healthy": false,
            "dnsConfirmed": false,
            "provisioned": false,
            "type": "ARecord",
            "displayType": "A",
            "domainName": "pressable.com",
            "ipAddresses": [
                "199.16.172.38",
                "199.16.173.236"
            ],
            "zoneId": 1
        },
        {
            "id": 22,
            "created": "2022-02-02T17:02:51.000Z",
            "primary": false,
            "name": "www",
            "healthy": false,
            "dnsConfirmed": false,
            "type": "ARecord",
            "displayType": "A",
            "provisioned": false,
            "domainName": "www.pressable.com",
            "ipAddresses": [
                "199.16.172.38",
                "199.16.173.236"
            ],
            "zoneId": 1
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Add Domain

Add a new domain to a site.

Note: Should you prefer to segregate the domain response by IP address, utilize the optional separate_records parameter and set its value to true. This enables you to view which domains are directed towards specific IP addresses, along with the precise domain ID for each individual record.

curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/domains' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "newdomain.com"
}'

Parameters

ID of the site to which to add the domain

site_id (required)

integer($int64)

(path)

Data used to add domain to site

data (required)

(body)

{
    "message": "Success",
    "data": [
        {
            "id": 20,
            "created": "2022-02-02T17:02:51.000Z",
            "primary": true,
            "name": null,
            "healthy": false,
            "dnsConfirmed": false,
            "provisioned": false,
            "domainName": "pressable.com",
            "ipAddresses": [
                "199.16.172.38",
                "199.16.173.236"
            ]
        },
        {
            "id": 22,
            "created": "2022-02-02T17:02:51.000Z",
            "primary": false,
            "name": "www",
            "healthy": false,
            "dnsConfirmed": false,
            "provisioned": false,
            "domainName": "www.pressable.com",
            "ipAddresses": [
                "199.16.172.38",
                "199.16.173.236"
            ]
        },
        {
            "id": 35,
            "created": "2022-02-18T16:49:40.000Z",
            "primary": false,
            "name": null,
            "healthy": false,
            "dnsConfirmed": false,
            "provisioned": false,
            "domainName": "newdomain.com",
            "ipAddresses": [
                "199.16.172.38",
                "199.16.173.236"
            ]
        },
        {
            "id": 37,
            "created": "2022-02-18T16:49:40.000Z",
            "primary": false,
            "name": "www",
            "healthy": false,
            "dnsConfirmed": false,
            "provisioned": false,
            "domainName": "www.newdomain.com",
            "ipAddresses": [
                "199.16.172.38",
                "199.16.173.236"
            ]
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

201

Created

Get Domain

Get domain information.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/domains/{id}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site to which to get the domains

site_id (required)

integer($int64)

(path)

ID of the domain to get

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 35,
        "created": "2022-02-18T16:49:40.000Z",
        "primary": false,
        "name": null,
        "healthy": false,
        "dnsConfirmed": false,
        "provisioned": false,
        "domainName": "newdomain.com",
        "ipAddresses": [
            "199.16.172.38",
            "199.16.173.236"
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Delete Domain

Delete a domain from a site.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/domains/{id}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site to which to delete the domain

site_id (required)

integer($int64)

(path)

ID of the domain to delete

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Set Primary Domain

Set a domain as the primary domain. All other ARecord domains attached to your site will redirect to the primary domain.

Note: To reset your primary domain to the staging domain send a domain id of -1

curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/domains/{id}/primary' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site to which to set the primary domain

site_id (required)

integer($int64)

(path)

ID of the domain to set as the primary domain

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 15,
        "created": "2023-04-17T15:53:38.000Z",
        "primary": true,
        "name": "www",
        "healthy": true,
        "dnsConfirmed": true,
        "provisioned": true,
        "domainName": "pressable.dev",
        "ipAddresses": [
            "199.16.172.11",
            "199.16.173.88"
        ]
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get SFTP User List

Get a list of FTP users for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/ftp' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site to which to get the FTP users

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
        {
            "id": 1,
            "created": "2022-01-31T20:05:39.000Z",
            "accessed": "2022-01-31T20:05:39.000Z",
            "modified": "2022-01-31T20:05:39.000Z",
            "accountId": 2,
            "sftpDomain": "sftp.pressable.com",
            "siteId": 1,
            "siteName": "my-presssable-net",
            "username": "46e652f73b2afc",
            "owner": false,
            "email": "janedoe@pressable.dev"
        },
        {
            "id": 2,
            "created": "2022-01-31T20:05:39.000Z",
            "accessed": "2022-01-31T20:05:39.000Z",
            "modified": "2022-01-31T20:05:39.000Z",
            "accountId": 2,
            "sftpDomain": "sftp.pressable.com",
            "siteId": 1,
            "siteName": "my-presssable-net",
            "username": "6f4c70e32926e2",
            "owner": false,
            "email": "tomdoe@pressable.dev"
        },
        {
            "id": 49,
            "created": "2022-01-31T20:05:39.000Z",
            "accessed": "2022-01-31T20:05:39.000Z",
            "modified": "2022-01-31T20:05:39.000Z",
            "accountId": 2,
            "sftpDomain": "sftp.pressable.com",
            "siteId": 1,
            "siteName": "my-presssable-net",
            "username": "6dccad86",
            "owner": false,
            "email": "clairedoe@pressable.dev"
        },
        {
            "id": 1303,
            "created": "2022-01-31T20:05:40.000Z",
            "accessed": "2022-01-31T20:05:40.000Z",
            "modified": "2022-01-31T20:05:40.000Z",
            "accountId": 2,
            "sftpDomain": "sftp.pressable.com",
            "siteId": 1,
            "siteName": "my-presssable-net",
            "username": "my-presssable-net",
            "owner": true,
            "email": "johndoe@pressable.dev"
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get SFTP User

Get SFTP user by Id for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/ftp/{username}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site to which to get the FTP users

site_id (required)

integer($int64)

(path)

Username of the site FTP user for which to get

username (required)

string

(path)

{
    "message": "Success",
    "data": {
        "id": 1303,
        "created": "2022-01-31T20:05:40.000Z",
        "accessed": "2022-01-31T20:05:40.000Z",
        "modified": "2022-01-31T20:05:40.000Z",
        "accountId": 2,
        "sftpDomain": "sftp.pressable.com",
        "siteId": 1,
        "siteName": "my-presssable-net",
        "username": "my-presssable-net",
        "owner": true,
        "email": "johndoe@pressable.dev"
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Reset SFTP User Password

Reset an FTP user password for the specified user and site.

curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/ftp/password/{username}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf'

Parameters

ID of the site for which to reset the FTP user password

site_id (required)

integer($int64)

(path)

Username of the site FTP user for which to reset the password

username (required)

string

(path)

{
    "message": "Success",
    "data": "076b2818de6e39",
    "errors": null
}

Responses

Number

Message

Code

200

Success

Jetpack License Information

Get the Jetpack license information for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/jetpack' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site for which to get the Jetpack license information

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 948,
        "siteId": 1,
        "licenseKey": "premium_5bc9f55f12",
        "issuedAt": 1643659537,
        "revokedAt": null
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Set Jetpack License

When setting the Jetpack license on your site, the license will be set in the WP Options table for your site.

More information:https://pressable.com/knowledgebase/what-is-the-jetpack-set-license-button

curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/jetpack' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site for which to set the Jetpack license

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Statistics

Get a list of statistics for a site. Data is updated once daily.

Statistical Data

File System disk usage in bytes
Database disk usage in bytes
Page Views
- People - Unique Visits
- Views - Total Page Views

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/statistics' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site to which to get the statistics

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 1,
        "databaseUsageBytes": 12656507,
        "fileSystemUsageBytes": 11981824,
        "pageViews": {
            "today": {
                "people": 0,
                "views": 0
            },
            "yesterday": {
                "people": 0,
                "views": 0
            },
            "currentMonth": {
                "people": 0,
                "views": 0
            },
            "lastMonth": {
                "views": 0,
                "people": 0
            },
            "twoMonthsAgo": {
                "views": 0,
                "people": 0
            },
            "lastOneYear": {
                "people": 25,
                "views": 29
            },
            "lastTwoYears": {
                "people": 290,
                "views": 335
            }
        }
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Add Tags

Add tags to your site. Tags allow you to add context to your sites and you can use them to define what your sites are related to.

Tags added to your site are not added to your collaborators tags, in order to add a tag for a collaborator to see you must add it through the collaborator site tag endpoints.

Tag Names(array) (required)

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/tags' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tag_names": [
    "paper", "plastic"
  ]
}'

Parameters

ID of the site

site_id (required)

integer($int64)

(path)

Name of the tag to add to the site

data (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2022-01-31T20:05:30.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 3,
        "datacenterCode": "DFW",
        "datacenterName": "Dallas, TX, USA",
        "displayName": "pressable.com",
        "domainsCount": 2,
        "ecommerce": false,
        "edgeCache": "enabled",
        "edgeCacheDefensiveMode": false,
        "edgeCacheDefensiveModeUntil": nil,
        "favorite": false,
        "ipAddress": "199.16.172.38",
        "ipAddressOne": "199.16.172.38",
        "ipAddressTwo": "199.16.173.236",
        "name": "my-presssable-net",
        "state": "live",
        "url": "pressable.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "wordpressVersion": "Latest Release (Beta)",
        "tags": [
            {
                "id": 1357,
                "name": "Halo 3: ODST"
            },
            {
                "id": 2605,
                "name": "paper"
            },
            {
                "id": 2606,
                "name": "plastic"
            }
        ],
        "wpEnvironmentType": "production",
        "lightWeight404": true,
        "multisiteSupport": false
    },
    "errors": null
}

Responses

Number

Message

Code

200

Created

Remove Tags

Remove tags from your site.

Tags removed from your site are not removed from your collaborators tags, in order to remove a tag for a collaborator you must remove it through the collaborator site tag endpoints.

Tag Ids(array) (required)

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/tags' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tag_ids": [
    2605,2606
  ]
}'

Parameters

ID of the site

site_id (required)

integer($int64)

(path)

ID(s) of the tags to remove (array)

data (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2022-01-31T20:05:30.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 3,
        "datacenterCode": "DFW",
        "datacenterName": "Dallas, TX, USA",
        "displayName": "pressable.com",
        "domainsCount": 2,
        "ecommerce": false,
        "favorite": false,
        "ipAddress": "199.16.172.38",
        "ipAddressOne": "199.16.172.38",
        "ipAddressTwo": "199.16.173.236",
        "name": "my-presssable-net",
        "state": "live",
        "url": "pressable.com",
        "staging": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "wordpressVersion": "Latest Release (Beta)",
        "tags": [
            {
                "id": 1357,
                "name": "Halo 3: ODST"
            }
        ],
        "wpEnvironmentType": "production",
        "lightWeight404": true,
        "multisiteSupport": true
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Note List

Get the notes attached to the requested site.

Additional accepted parameters include “per_page” and "page".

per_page: the amount of notes returned in a response
page: the page of the response

When paginating additional information will be placed in the response regarding paging information:

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/notes' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf' \
--data '{
    "per_page": 1,
    "page": 2
}'

Parameters

ID of the site

id (required)

integer($int64)

(path)

Data used to get notes for a site

data (required)

(body)

{
    "message": "Success",
    "data": [
        {
            "id": 418,
            "author": "janedoe@pressable.dev",
            "editor": "janedoe@pressable.dev",
            "subject": "Note Subject",
            "body": "Notes content",
            "created": "2022-02-14T16:45:43.000Z",
            "updated": "2022-02-14T16:45:43.000Z"
        }
    ],
    "page": {
        "currentPage": 2,
        "nextPage": null,
        "lastPage": 2,
        "perPage": 1,
        "totalItems": 2
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Add Note

Add notes to your site.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/notes' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf' \
--header 'Content-Type: application/json' \
--data-raw '{
  "subject": "A note created by the Pressable API",
  "body": "This is the main content of the note."
}'

Parameters

ID of the site

id (required)

integer($int64)

(path)

Data used to get notes for a site

data (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 8,
        "author": "johndoe@pressable.dev",
        "editor": "johndoe@pressable.dev",
        "subject": "A note created by the Pressable API",
        "body": "This is the main content of the note.",
        "created": "2022-02-18T17:34:45.000Z",
        "updated": "2022-02-18T17:34:45.000Z"
    },
    "errors": null
}

Responses

Number

Message

Code

200

Created

Get Note

Get specified note for site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/notes/{id}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf'

Parameters

ID of the site

site_id (required)

integer($int64)

(path)

ID of the note

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "id": 8,
        "author": "johndoe@pressable.dev",
        "editor": "johndoe@pressable.dev",
        "subject": "A note created by the Pressable API",
        "body": "This is the main content of the note.",
        "created": "2022-02-18T17:34:45.000Z",
        "updated": "2022-02-18T17:34:45.000Z"
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Update Note

Update note for your site.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/notes/{id}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf' \
--header 'Content-Type: application/json' \
--data-raw '{
  "subject": "Updated note by the Pressable API",
  "body": "This is the updated content of the note."
}'

Parameters

ID of the site

site_id (required)

integer($int64)

(path)

ID of the note

id (required)

integer($int64)

(path)

Data used to update a note

data (required)

(body)

{
    "message": "Success",
    "data": {
        "id": 8,
        "author": "johndoe@pressable.dev",
        "editor": "janedoe@pressable.dev",
        "subject": "Updated note by the Pressable API",
        "body": "This is the updated content of the note.",
        "created": "2022-02-18T17:34:45.000Z",
        "updated": "2022-02-18T17:38:01.000Z"
    },
    "errors": null
}

Responses

Number

Message

Code

200

Updated

Delete Note

Delete a note from your site.

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/notes/{id}' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf'

Parameters

ID of the site

site_id (required)

integer($int64)

(path)

ID of the note

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Reset WP-Admin Password

Reset the site owner's WP-Admin password. If you (account owner) are unable to log into your site’s WordPress dashboard because of a forgotten, or unknown, password, this endpoint can be used to set your WP Admin password to a randomly generated value.

More information:https://pressable.com/knowledgebase/resetting-your-wp-admin-password

curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/wordpress/password-reset' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'

Parameters

ID of the site to set WordPress password for

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": "%Y6hDU%-Yu5okh5AvGN",
    "errors": null
}

Responses

Number

Message

Code

200

Success

Get phpMyAdmin URL for Site

Get a time-limited URL for accessing your site's database via phpMyAdmin. Only request the URL when you are ready for it to be used. We recommend requesting the URL and redirecting to the URL in the response as soon as possible.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/wordpress/phpmyadmin' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'

Parameters

ID of the site to get the phpMyAdmin URL for

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": "https://pressable.com/_pma_login?timestamp=1646159015&nonce=202733835103&token=c47c6b938",
    "errors": null
}

Responses

Number

Message

Code

200

Success

Update WordPress Version for Site

Update your WordPress version to one of our available versions. If no version is sent in the request your WordPress version will be toggled between latest (stable) or beta (when available).

Available Versions

latest - Current Stable Version (6.7)

curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/wordpress/version' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz' \
--data-raw '{ \
  "version": "latest" \
}'

Parameters

ID of the site to toggle the WordPress version for

site_id (required)

integer($int64)

(path)

Data used to update to specified version

version (latest)

string

(body)

{
    "message": "Success",
    "data": {
        "id": 1,
        "created": "2022-02-17T20:50:05.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 0,
        "datacenterCode": "DCA",
        "datacenterName": "Washington, DC, USA",
        "displayName": "your-site-name",
        "domainsCount": 0,
        "ecommerce": false,
        "favorite": false,
        "ipAddress": "199.16.172.70",
        "ipAddressOne": "199.16.172.70",
        "ipAddressTwo": "199.16.173.246",
        "name": "your-site-name",
        "state": "deploying",
        "url": "your-site-name.mystagingwebsite.com",
        "staging": true,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "wordpressVersion": "Current Stable Release (6.2)",
        "tags": [],
        "wpEnvironmentType": "staging",
        "lightWeight404": true,
        "multisiteSupport": true
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Creates a one time url to sign-in to one of your WordPress sites as the user specified by the given email.

Please check our Knowledge Base for more information about this feature. In order for this endpoint to work properly, please make surethe following requirements are met:

Site's account owner must have the OnePress Login to WordPres plugin enabled.
The user specified byemailmust be a collaborator for the given site and must haveWP_ACCESSpermission.
The user agent value must be anexact matchcompared to the browser that will be used to the visit the generated url.
The generated url must be used within 30 seconds of being generated.

The ideal workflow would involve an end user sending a request to your server, which retrieves the user-agent and proceeds to send a request to Pressable's API with the remaining values. You can use the following examples to retrieve the user-agent from a web request:

PHP:

$_SERVER['HTTP_USER_AGENT']

Node:

var http = require('http')
server = http.createServer(function(req) {
  console.log(req.headers['user-agent']);
});

curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/one_press_login' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "some_cool_user@mydomain.com",
  "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36"
}'

Parameters

ID of the site for which we want to generate the sign-in url

site_id (required)

integer($int64)

(path)

Email of the user for which we want to create the sign-in url for

email (required)

string

(body)

User agent of the browser that will request the generated url

user_agent (required)

string

(body)

{
  "message": "Success",
  "data": {
      "url": "https://mydomain.com/wp-login.php?mpcp_token=MS00Mzg1OTNlOTYzMjNkMWY3NTEjk4NjYtODU1YWJlMzNmNjEwNI"
  },
  "errors": null
}

Responses

Number

Message

Code

200

Success

PHP Error Logs

Get a list of a site's PHP logs. These logs can help assist in debugging issues related to PHP on your site. The logs are available for the past 7 days, we respond with 200 log messages per page.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/logs/php' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json' \
--data-raw '{
  "scroll_id": "FGluY2x1ZGVi1CFVU2Fxckbnc=",
  "status": "Warning"
}'

Scroll ID

The scroll id string is used to get the next page of data for your request. Any filters sent along with a scroll id will be used when getting the next page of data.

Status Options

Filter by log status. status can be set to one of either:

User
Warning
Deprecated
Fatal error
Parse error

Parameters

Id of the site to which to get the logs

id (required)

integer($int64)

(path)

Status Code Severity Filter

status

string

(query)

Scroll ID for paging

scroll_id

string

(query)

{
    "total_results": null,
    "logs": [
        {
            "message": "cool error!!",
            "severity": "User",
            "kind": "",
            "name": "",
            "file": "unknown",
            "line": -1,
            "timestamp": "2023-02-03T22:15:46.000Z",
            "atomic_site_id": 149667564
        },
        {
            "message": "PHP Parse error:  Unmatched ')' in /srv/htdocs/throw_error.php on line 4",
            "severity": "Parse error",
            "kind": "",
            "name": "",
            "file": "/srv/htdocs/throw_error.php",
            "line": 4,
            "timestamp": "2023-02-03T22:13:32.000Z",
            "atomic_site_id": 149667564
        }
    ],
    "scroll_id": "FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5VGhlbkZldGNogAgWdGdWQWZTeHBUaGFJTG1fR0E0LVp2dwAAAAABPOLVFnZ6SFlEODV0UUt1bklUWGs0STdjbVEWeVNlaU56eDdRek9WRmhGQjJHZEk2dwAAAAAEdcDJFkhiWDJMaHc0UWdXbXNRME9uQUZLaHcWSUlDQnhTOGtScmlrMFR1OFM3azlFdwAAAAAEV8-iFnRMcHN2OGdMUmR1M0NROWxQeFp6ZGcWTVItdXJuSW1UVXFKZkhLWktIVDdDdwAAAAAEJkfNFn="
}

Responses

Number

Message

Code

200

Success

Web Server Logs

Get a list of a site's web server logs. These logs can help assist in debugging issues related to the server of your site. The logs are available for the past 7 days, we respond with 200 log messages per page.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/logs/server' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scroll_id": "FGluY2x1ZGVi1CFVU2Fxckbnc=",
    "status": "200",
    "request_type": "GET",
    "user_ip":"172.12.29.1"
  }'

Scroll ID

The scroll id string is used to get the next page of data for your request. Any filters sent along with a scroll id will be used when getting the next page of data.

Request Type

Filter by request type. request_type can be set to one of either:

GET
POST
PUT
PATCH
DELETE

Status Codes

Filter by status codes. status can be set to any valid status code of 100 through 599. Multiple status codes can be sent as comma delimited string of codes, such as, status: '200, 202'

User IP

Filter by User IP address using user_ip.

Parameters

id for the site logs you want

id (required)

integer($int64)

(path)

Status Code

status

string

(query)

Request Type

request_type

string

(query)

User IP Address

user_ip

string

(query)

Scroll ID for paging

scroll_id

string

(query)

{
   "total_results":null,
   "logs":[
      {
         "body_bytes_sent":32,
         "cached":"false",
         "date":"2023-02-03T19:21:53.162Z",
         "http2":"",
         "http_host":"fatwombat.online",
         "http_referer":"https://fatwombat.online/wp-json/jetpack/v4/sync/spawn-sync?time=1675452113&request_lock_id=1675452113.1056",
         "http_user_agent":"WordPress/6.1.1; https://fatwombat.online",
         "http_version":"HTTP/1.1",
         "http_x_forwarded_for":"103.115.8.95",
         "renderer":"php",
         "request_completion":"OK",
         "request_time":0.036,
         "request_type":"GET",
         "request_url":"/wp-json/jetpack/v4/sync/spawn-sync?time=1675452113&request_lock_id=1675452113.1056",
         "scheme":"http",
         "status":200,
         "timestamp":1675452113,
         "type":"nginx_json",
         "user_ip":"103.115.8.95"
      },
      {
         "body_bytes_sent":198,
         "cached":"false",
         "date":"2023-02-03T17:49:49.405Z",
         "http2":"",
         "http_host":"fatwombat.online",
         "http_referer":"",
         "http_user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.61 Safari/537.36",
         "http_version":"HTTP/1.1",
         "http_x_forwarded_for":"89.104.101.102",
         "renderer":"static",
         "request_completion":"OK",
         "request_time":0,
         "request_type":"GET",
         "request_url":"/favicon.ico",
         "scheme":"http",
         "status":200,
         "timestamp":1675446589,
         "type":"nginx_json",
         "user_ip":"89.104.101.102"
      }
   ],
   "scroll_id":"FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5VGhlbkZldGNogAgWdGdWQWZTeHBUaGFJTG1fR0E0LVp2dwAAAAABPOLVFnZ6SFlEODV0UUt1bklUWGs0STdjbVEWeVNlaU56eDdRek9WRmhGQjJHZEk2dwAAAAAEdcDJFkhiWDJMaHc0UWdXbXNRME9uQUZLaHcWSUlDQnhTOGtScmlrMFR1OFM3azlFdwAAAAAEV8-iFnRMcHN2OGdMUmR1M0NROWxQeFp6ZGcWTVItdXJuSW1UVXFKZkhLWktIVDdDdwAAAAAEJkfNFn="
}

Responses

Number

Message

Code

200

Success

Activity Logs

Get a list of your site's activity logs to track user actions and assist in debugging.Logs, available for the previous 30 days, can shed light on user activities on your site. Please note that we provide up to 50 log messages per page in our responses.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/logs/activity' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImzvz' \
--header 'Content-Type: application/json' \
--data-raw '{
      "page": 1,
      "per_page": 5,
      "filters": [
          {
              "field": "action",
              "operator": "contains",
              "value": "report"
          },
          {
              "field": "account_email",
              "operator": "equals",
              "value": "systems@pressable.com"
          }
     ]
  }'

Page

The page integer is used to get the specified page of data for your request.

Per Page

The per_page integer is used to limit the amount of log messages for your request (max of 50 log messages per page).

Filters

action
account_email
ip_address
source ( ui | api.v1 | systems )

Filter Actions

Filter actions can be set to any one of the following values returned from the site-actions activity endpoint.

Parameters

id for the site logs you want

id (required)

integer($int64)

(path)

Page

page

integer

(body)

Per Page

per_page

integer

(body)

Filters

filters

array

(body)

{
    "message": "Success",
    "data": [
      {
        "id": 4644222,
        "timestamp": "2023-09-28T11:02:55.141Z",
        "accountEmail": "systems@pressable.com",
        "ipAddress": null,
        "userAgent": "PressableRuntime",
        "name": "report.page_views",
        "description": "Page Views Report",
        "source": "systems",
        "message": "Importing page view data"
      },
      {
        "id": 4515941,
        "timestamp": "2023-09-27T10:47:55.476Z",
        "accountEmail": "systems@pressable.com",
        "ipAddress": null,
        "userAgent": "PressableRuntime",
        "name": "performance_report.screenshot",
        "description": "Performance Report Screenshot",
        "source": "systems",
        "message": "Imported performance report desktop and mobile screenshot"
      },
      {
        "id": 4476895,
        "timestamp": "2023-09-27T02:06:54.624Z",
        "accountEmail": "systems@pressable.com",
        "ipAddress": null,
        "userAgent": "PressableRuntime",
        "name": "report.space_usage",
        "description": "Space Usage Report",
        "source": "systems",
        "message": "Imported space usage data: Filesystem 11939840 bytes | Database 12701498 bytes"
      },
      {
        "id": 4123048,
        "timestamp": "2023-09-24T23:02:51.986Z",
        "accountEmail": "systems@pressable.com",
        "ipAddress": null,
        "userAgent": "PressableRuntime",
        "name": "report.page_views",
        "description": "Page Views Report",
        "source": "systems",
        "message": "Importing page view data"
      }
    ],
    "page": {
      "currentPage": 1,
      "nextPage": 2,
      "lastPage": 7,
      "perPage": 5,
      "totalItems": 35
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Site Activity Log Actions

Retrieve a list of actions that you can use to filter a site's activity logs. Use the value in the 'name' field for filtering the logs.

The example response displays only a limited selection of actions. You can find the comprehensive list of actions in the actual API response.

curl --location --request GET 'https://my.pressable.com/v1/activity/site-actions' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz' \

{
    "message": "Success",
    "data": [
        {
            "name": "backup.downloaded",
            "description": "Backup Downloaded"
        },
        {
            "name": "wordpress.lightweight_404.disabled",
            "description": "Lightweight 404 Disabled"
        },
        {
            "name": "wordpress.lightweight_404.enabled",
            "description": "Lightweight 404 Enabled"
        },
        {
            "name": "wordpress.object_cache",
            "description": "Object Cache Purged"
        },
        {
            "name": "wordpress.phpmyadmin_accessed",
            "description": "phpMyAdmin Accessed"
        },
        {
            "name": "wordpress.version_updated",
            "description": "WordPress Version Updated"
        }
    ],
    "errors": null
  }

Responses

Number

Message

Code

200

Success

Disconnect SSH

Terminate all SSH connections for a site.

Caution: This will affect all active SSH connections, including Pressable SSH connections.

curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/disconnect-ssh' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json'

Parameters

ID of the site for which to disconnect SSH connections for

site_id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Responses

Number

Message

Code

200

Success

Latest Performance Report

Get the data corresponding to the latest performance report generated for a given site. Please note that this data is automatically generated by the Lighthouse tool. Click here for more details .

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/reports/performance/latest' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json'

Getting an empty response means there is no available performance report for the given site and you may need to retry later.

If there is a performance report available, the data attribute in the response is always expected to have 2 keys: desktop_report and mobile_report. each one with its expected values.

Parameters

Id of the site for which you want to get the latest performance report of.

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": {
        "desktop_report": {
            "created_at": "2023-09-05T23:15:55Z",
            "updated_at": "2023-09-05T23:15:55Z",
            "final_url": "https://fatwombat.online/",
            "thumbnail_location": "https://pressable-performance-reports-staging.s3.amazonaws.com/791/2023-09-05/2023-09-05T23%3A15%3A55.873Z_desktop_tn.jpg",
            "performance_score": 0.99,
            "performance_title": "Performance",
            "accessibility_score": 1.0,
            "accessibility_title": "Accessibility",
            "best_practices_score": 1.0,
            "best_practices_title": "Best Practices",
            "seo_score": 1.0,
            "seo_title": "SEO",
            "first_contentful_paint_title": "First Contentful Paint",
            "first_contentful_paint_description": "First Contentful Paint marks the time at which the first text or image is painted.\nLearn more.",
            "first_contentful_paint_score": 0.98,
            "first_contentful_paint_display_value": "0.7 s",
            "first_contentful_paint_numeric_value": "682.552",
            "first_contentful_paint_numeric_unit": "millisecond",
            "interactive_title": "Time to Interactive",
            "interactive_description": "Time to interactive is the amount of time it takes for the page to become fully interactive.\nLearn more.",
            "interactive_score": 1.0,
            "interactive_display_value": "0.7 s",
            "interactive_numeric_value": "745.356",
            "interactive_numeric_unit": "millisecond",
            "speed_index_title": "Speed Index",
            "speed_index_description": "Speed Index shows how quickly the contents of a page are visibly populated. \nLearn more.",
            "speed_index_score": 0.99,
            "speed_index_display_value": "0.8 s",
            "speed_index_numeric_value": "847.931",
            "speed_index_numeric_unit": "millisecond",
            "total_blocking_time_title": "Total Blocking Time",
            "total_blocking_time_description": "Sum of all time periods between FCP and Time to Interactive, when task length exceeded 50ms, expressed in milliseconds.\nLearn more.",
            "total_blocking_time_score": 1.0,
            "total_blocking_time_display_value": "10 ms",
            "total_blocking_time_numeric_value": "13.0",
            "total_blocking_time_numeric_unit": "millisecond",
            "largest_contentful_paint_title": "Largest Contentful Paint",
            "largest_contentful_paint_description": "Largest Contentful Paint marks the time at which the largest text or image is painted.\nLearn more.",
            "largest_contentful_paint_score": 0.97,
            "largest_contentful_paint_display_value": "0.9 s",
            "largest_contentful_paint_numeric_value": "865.874",
            "largest_contentful_paint_numeric_unit": "millisecond",
            "cumulative_layout_shift_title": "Cumulative Layout Shift",
            "cumulative_layout_shift_description": "Cumulative Layout Shift measures the movement of visible elements within the viewport. \nLearn more.",
            "cumulative_layout_shift_score": 1.0,
            "cumulative_layout_shift_display_value": "0",
            "cumulative_layout_shift_numeric_value": "0.0",
            "cumulative_layout_shift_numeric_unit": "unitless",
            "server_response_time_title": "Initial Server Response Time",
            "server_response_time_description": "Keep the server response time for the main document short because all other requests depend on it. \n[Learn more](https://web.dev/time-to-first-byte/).",
            "server_response_time_score": 1.0,
            "server_response_time_display_value": "Root document took 350 ms",
            "server_response_time_numeric_value": "353.493",
            "server_response_time_numeric_unit": "millisecond",
            "lighthouse_version": "9.6.8",
            "fetch_time": "2023-09-05T23:15:58Z"
        },
        "mobile_report": {
            "created_at": "2023-09-05T23:15:55Z",
            "updated_at": "2023-09-05T23:15:55Z",
            "final_url": "https://fatwombat.online/",
            "thumbnail_location": "https://pressable-performance-reports-staging.s3.amazonaws.com/791/2023-09-05/2023-09-05T23%3A15%3A55.873Z_mobile_tn.jpg",
            "performance_score": 0.84,
            "performance_title": "Performance",
            "accessibility_score": 1.0,
            "accessibility_title": "Accessibility",
            "best_practices_score": 1.0,
            "best_practices_title": "Best Practices",
            "seo_score": 1.0,
            "seo_title": "SEO",
            "first_contentful_paint_title": "First Contentful Paint",
            "first_contentful_paint_description": "First Contentful Paint marks the time at which the first text or image is painted.\nLearn more.",
            "first_contentful_paint_score": 0.77,
            "first_contentful_paint_display_value": "2.2 s",
            "first_contentful_paint_numeric_value": "2229.358",
            "first_contentful_paint_numeric_unit": "millisecond",
            "interactive_title": "Time to Interactive",
            "interactive_description": "Time to interactive is the amount of time it takes for the page to become fully interactive.\nLearn more.",
            "interactive_score": 0.89,
            "interactive_display_value": "3.8 s",
            "interactive_numeric_value": "3842.291",
            "interactive_numeric_unit": "millisecond",
            "speed_index_title": "Speed Index",
            "speed_index_description": "Speed Index shows how quickly the contents of a page are visibly populated. \nLearn more.",
            "speed_index_score": 0.99,
            "speed_index_display_value": "2.2 s",
            "speed_index_numeric_value": "2229.358",
            "speed_index_numeric_unit": "millisecond",
            "total_blocking_time_title": "Total Blocking Time",
            "total_blocking_time_description": "Sum of all time periods between FCP and Time to Interactive, when task length exceeded 50ms, expressed in milliseconds.\nLearn more.",
            "total_blocking_time_score": 0.89,
            "total_blocking_time_display_value": "200 ms",
            "total_blocking_time_numeric_value": "200.477",
            "total_blocking_time_numeric_unit": "millisecond",
            "largest_contentful_paint_title": "Largest Contentful Paint",
            "largest_contentful_paint_description": "Largest Contentful Paint marks the time at which the largest text or image is painted.\nLearn more.",
            "largest_contentful_paint_score": 0.65,
            "largest_contentful_paint_display_value": "3.5 s",
            "largest_contentful_paint_numeric_value": "3464.678",
            "largest_contentful_paint_numeric_unit": "millisecond",
            "cumulative_layout_shift_title": "Cumulative Layout Shift",
            "cumulative_layout_shift_description": "Cumulative Layout Shift measures the movement of visible elements within the viewport. \nLearn more.",
            "cumulative_layout_shift_score": 1.0,
            "cumulative_layout_shift_display_value": "0",
            "cumulative_layout_shift_numeric_value": "0.0",
            "cumulative_layout_shift_numeric_unit": "unitless",
            "server_response_time_title": "Initial Server Response Time",
            "server_response_time_description": "Keep the server response time for the main document short because all other requests depend on it. \n[Learn more](https://web.dev/time-to-first-byte/).",
            "server_response_time_score": 1.0,
            "server_response_time_display_value": "Root document took 80 ms",
            "server_response_time_numeric_value": "80.431",
            "server_response_time_numeric_unit": "millisecond",
            "lighthouse_version": "9.6.8",
            "fetch_time": "2023-09-05T23:16:15Z"
        }
    },
    "errors": null
}

Responses

Number

Message

Code

200

Success

Site Usage Report

Get the usage details for a given site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/reports/usage' \
--header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' \
--header 'Content-Type: application/json'

Parameters

Id of the site for which you want to get the latest usage report of.

id (required)

integer($int64)

(path)

{
    "message": "Success",
    "data": [
        {
            "billing_cycle": {
                "end_date": "2024-02-11T00:35:48.000Z",
                "start_date": "2024-01-11T00:35:48.000Z",
                "total_daily_average_storage_usage_in_gigabytes": 200,
                "total_unique_visits": 1000,
                "site": {
                    "id": 1,
                    "name": "my-presssable-net",
                    "url": "https://my-presssable-net.mystagingwebsite.com",
                    "daily_average_visits": 100,
                    "daily_average_storage_usage_in_gigabytes": 9.054
                }
            }
        }
    ],
    "errors": null
}

Responses

Number

Message

Code

200

Success

Themes

Themes are design templates that determine the visual layout and style of a WordPress website, including elements like headers, footers, content display, and overall aesthetics. They can be customized or replaced to achieve a desired look and feel.

With these API endpoints, you can manage themes for your sites.

Theme List

Get a list of themes for the specified site.

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/themes' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' \
--header 'Content-Type: application/json'

Parameters

ID of the site to get themes for

id (required)

integer($int64)

(path)

{
  "message": "Success",
  "data": [
      {
        "name": "astra",
        "title": "Astra",
        "description": "Astra is fast, fully customizable & beautiful WordPress theme suitable\nfor blog, personal portfolio, business website and WooCommerce storefront.\nIt is very lightweight (less than 50KB on frontend) and offers unparalleled\nspeed. Built with SEO in mind, Astra comes with Schema.org code integrated\nand is Native AMP ready so search engines will love your site. It offers\nspecial features and templates so it works perfectly with all page builders\nlike Elementor, Beaver Builder, Visual Composer, SiteOrigin, Divi, etc.\nSome of the other features: # WooCommerce Ready # Responsive # RTL &\nTranslation Ready # Extendible with premium addons # Regularly updated #\nDesigned, Developed, Maintained & Supported by Brainstorm Force.\nLooking for a perfect base theme? Look no further. Astra is fast, fully\ncustomizable and WooCommerce ready theme that you can use for building any\nkind of website!",
        "status": "inactive",
        "update": "available",
        "version": "4.1.4",
        "update_version": "4.1.5"
      },
      {
        "name": "kadence",
        "title": "Kadence",
        "description": "Kadence Theme is a lightweight yet full featured WordPress theme for\ncreating beautiful fast loading and accessible websites, easier than ever.\nIt features an easy to use drag and drop header and footer builder to build\nany type of header in minutes. It features a full library of gorgeous\nstarter templates that are easy to modify with our intelligent global font\nand color controls. With extensive integration with the most popular 3rd\nparty plugins, you can quickly build impressive ecommerce websites, course\nwebsites, business websites, and more.",
        "status": "active",
        "update": "available",
        "version": "1.1.36",
        "update_version": "1.1.39"
      }
  ],
  "errors": null
}

Install and Activate Themes

You may want to install a WordPress theme to give your website a professional appearance without needing extensive coding skills. Themes offer ready-made design and functionality, allowing you to easily customize your site's layout, color scheme, typography, and more, ensuring it aligns with your brand or personal style.

This endpoint installs and activates a theme for the specified site. Job Queues are used to install and activate the themes. Please use our Theme related Webhooks to know if the theme was installed and activated successfully.

Themes can be installed from the WordPress theme repository or from a custom URL.

To install a theme from the WordPress theme repository, use the theme name (slug). If a slug is used the WordPress API is used to determine if the theme slug is valid. To install a theme from a custom URL, use the HTTPS URL to the theme zip file.

The theme version is an optional parameter. If not specified, the latest version of the theme will be installed.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/themes' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "themes": [
        {
            "path": "astra",
            "version": "4.1.4"
        },
        {
            "path": "https://downloads.wordpress.org/theme/kadence.1.1.36.zip"
        }
    ]
}'

Parameters

ID of the site to install and activate themes for

id (required)

integer($int64)

(path)

Array of theme objects to install and activate with their version and path details

themes (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Update Themes

Updating WordPress themes is crucial for maintaining site security, fixing bugs, and ensuring compatibility with the latest WordPress core updates. Theme updates often include new features and improvements in design and performance, enhancing user experience and the overall functionality of the website.

This endpoint updates themes for the specified site. Job Queues are used to update the themes. Please use our Theme related Webhooks to know if the theme was updated successfully.

Themes are updated using the theme name (slug).

The theme version is an optional parameter. If not specified, the theme will be updated to the latest version.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/themes' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "themes": [
        {
            "path": "astra",
            "version": "4.1.4"
        }
    ]
}'

Parameters

ID of the site to update the themes for

id (required)

integer($int64)

(path)

Array of theme objects to update with their version and path details

themes (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Activate Themes

Activating a WordPress theme is important because it applies the selected theme's design and functionality to your website. Until a theme is activated, it won't influence your site's appearance or features. By activating a theme, you ensure your site reflects the aesthetic and functions you've chosen for your brand or content.

This endpoint activates a theme for the specified site. Job Queues are used to activate the theme. Please use our Theme related Webhooks to know if the theme was activated successfully.

A theme is activated using the theme name (slug).

Only one theme can be active at a time.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/themes/activate' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "themes": [
        {
            "path": "astra"
        }
    ]
}'

Parameters

ID of the site to activate the themes for

id (required)

integer($int64)

(path)

Array of theme objects to activate with their path details

themes (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Delete Themes

Deleting unused WordPress themes is important for maintaining site security and optimal performance. Unused themes can become outdated, posing a security risk if they aren't regularly updated. Moreover, they can take up valuable storage space, potentially slowing down your website. Therefore, it's best practice to delete themes you're not using.

This endpoint deletes themes for the specified site. Job Queues are used to delete the themes. Please use our Theme related Webhooks to know if the theme was deleted successfully.

Themes are deleted using the theme name (slug).

curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/themes' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "themes": [
        {
            "path": "astra"
        },
        {
            "path": "twentytwentythree"
        }
    ]
}'

Parameters

ID of the site to delete the themes for

id (required)

integer($int64)

(path)

Array of theme objects to delete with their path details

themes (required)

array

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

WordPress

Professionals often seek a more efficient way to manage and automate their WordPress sites. We are providing ways to interact with WordPress installations, offering speed and automation capabilities. Our API Endpoints elevate this efficiency by allowing customers to seamlessly integrate WP-CLI commands into their workflows. Whether you are looking to create a WordPress user or execute a myriad of other WP-CLI tasks, our API facilitates these operations directly, enabling a more streamlined site management experience.

WordPress User List

This endpoint retrieves a list of WordPress users from your site.

The response includes the `table_prefix`, `user_table`, `user_meta_table`, and `capabilities_meta_key`, which provide valuable configuration details. The table prefix is determined by a command that directly checks this setting from your site’s configuration.

Please note that the time taken to process this request can vary depending on the number of users in your site. We recommend using an AJAX style request for this endpoint to prevent blocking UI rendering within your applications.

per_page: the amount of users returned in a response, maximum 200, default 200
page: the page of the response, default 1

curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/wordpress/users' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "page": 1,
    "per_page": 50
}'

Parameters

id of the site to get the user list for

id (required)

string

(path)

page of the user list (default 1)

page (optional)

integer

(path)

per_page for the user list (maximum 200)

per_page (optional)

integer

(path)

{
    "message": "Success",
    "data": {
        "users": [
            {
                "id": 1,
                "user_login": "john.doe",
                "display_name": "john.doe",
                "user_email": "johndoe@email.com",
                "roles": "administrator"
            },
            {
                "id": 8,
                "user_login": "jane.doe",
                "display_name": "jane.doe",
                "user_email": "janedoe@email.com",
                "roles": "administrator, subscriber"
            }
        ],
        "total_user_count": 2,
        "per_page": 20,
        "page": 1,
        "table_prefix": "wp_",
        "user_table": "wp_users",
        "user_meta_table": "wp_usermeta",
        "capabilities_meta_key": "wp_capabilities"
    },
    "errors": null
}

Create WordPress User

This endpoint allows you to create a WordPress user directly within your site. The user won't be created in Pressable and its data won't be retained in our systems in any way.

Please note that the email received within the parameters, will be used as both the user-login and user-email of the new WordPress user, as required in WordPress documentation.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/wordpress/users' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "email": "my_new_user@mydomain.com"
}'

Parameters

email of the new user to be created within your WordPress site

email (required)

string

(body)

{
    "message": "Success",
    "data": {
        "id": "10",
        "email": "my_new_user@mydomain.com",
        "password": "1bb31b9bfee1e41644c8eec17c2d9bae"
    },
    "errors": null
}

Update WordPress User Password

This endpoint allows for the modification of a WordPress user's password directly on your site.

If a new password is not specified, a random password will be generated and assigned. The newly set password will be included in the response.

curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/wordpress/users/password-reset' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTBKh' \
--header 'Content-Type: application/json' \
--data '{
    "user": 8,
    "password": "my_new_password"
}'

Parameters

The user parameter should be assigned the login, email, or ID of the user whose WordPress password needs updating

user (required)

string

(body)

The password parameter is the new password to which the user's WordPress password will be updated

password (optional)

string

(body)

{
    "message": "Success",
    "data": "my_new_password",
    "errors": null
}

WP-CLI Commands

This endpoint allows you to run WP-CLI commands via the API. WP-CLI is the command-line interface for WordPress.

Please note that we prefix all commands with our appropriate WP-CLI path, so you do not include it in your request. For instance, if you wish to run the command wp role create employee Employee, your command array should look like this: [ 'role create employee Employee' ]

To stay informed when your commands are completed, we recommend integrating with our webhooks. Responses from the WP-CLI command are directly relayed back via these webhooks.

Please be aware:

Do not send sensitive information (passwords, API keys, etc.) via WP-CLI commands, as the messages are not encrypted and are stored in plain text for logging purposes.
Commands are executed as they are processed, so there is no guaranteed sequence when submitting multiple commands. For sequential execution, either input your commands one by one or run them manually.
Our system processes commands using job queues. If a command fails, it will not be retried.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/wordpress/wpcli' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTB' \
--header 'Content-Type: application/json' \
--data '{
    "commands": [
        "role create poster '\''Poster Only'\''",
        "role create employee Employee"
    ]
}'

Parameters

ID of the site you want to run the WP-CLI commands on

id (required)

string

(path)

Array of commands to run

commands (required)

array [string]

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Bash Commands

This endpoint allows you to run Bash commands via the API.

For instance, if you wish to run the command chmod 755 filename.php, your command array should look like this: [ 'chmod 755 filename.php' ]

To stay informed when your commands are completed, we recommend integrating with our webhooks. Responses from the Bash command are directly relayed back via these webhooks.

Please be aware:

Do not send sensitive information (passwords, API keys, etc.) via Bash commands, as the messages are not encrypted and are stored in plain text for logging purposes.
Commands are executed as they are processed, so there is no guaranteed sequence when submitting multiple commands. For sequential execution, either input your commands one by one or run them manually.
You can also chain commands using the && operator or use a pipe to pass the output of one command to another within a single command.
Our system processes commands using job queues. If a command fails, it will not be retried.

curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/wordpress/commands' \
--header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzTB' \
--header 'Content-Type: application/json' \
--data '{
    "commands": [
        "chmod 755 filename.php",
        "mv old-plugin.php new-plugin.php",
        "wp plugin activate my-plugin"
    ]
}'

Parameters

ID of the site you want to run the Bash commands on

id (required)

string

(path)

Array of Bash commands to run

commands (required)

array [string]

(body)

{
    "message": "Success",
    "data": null,
    "errors": null
}

Webhooks

Webhooks offer a way to find out when certain events occur within the My Pressable Control Panel. Adding a webhook URL allows you to subscribe to events and we will POST data to the URL you provide.

Webhooks are asynchronous events, but please DO NOT rely on webhooks for events that are time sensitive.

You should accept a webhook request by returning an HTTP "200 OK" response as quickly as possible from your endpoint. We attempt to send each webhook event 10 times before giving up.

Your webhook log messages are available for 90 days after creation.

Webhook URLs must use HTTPS protocol

Webhook Verification

Using your Account Shared Key and a HMAC SHA 256 signature that is calculated and sent with the Webhook, you can verify the contents of a Webhook as being from Pressable and un-tampered.

Example code for verifying webhooks written for Node.js and PHP.

Webhook Testing

Try using ngrok , or UltraHook , to create webhook test HTTPS URLs, allowing you to inspect the webhook body and headers from localhost.

Please be aware that we will automatically deactivate endpoints that encounter ngrok/ultrahook-specific errors, such as "Tunnel f3b8-110-39-36-126.ngrok-free.app not found ERR_NGROK_3200". If you are conducting tests, ensure that you deactivate the webhook URL after you finish testing.

Site Created

Sent when a site is created in your account.

{
    "event": "site_created",
    "site": {
        "id": 1,
        "state": "live"
    },
    "wp_admin": {
      "username": "johndoe",
      "email": "johndoe@email.com"
    }
}

Site Deleted

Sent when a site is deleted in your account.

{
    "event": "site_deleted",
    "site": {
        "id": 1
    }
}

Site Converted

Sent when a site is converted from staging to live or vice-versa

{
    "event": "site_converted",
    "site": {
        "id": 1,
        "site_converted_to": "staging"
    }
}

Site Enabled

Sent when a site is enabled

{
    "event": "site_enabled",
    "site": {
        "id": 1,
        "state": "live"
    }
}

Site Disabled

Sent when a site is disabled

{
    "event": "site_disabled",
    "site": {
        "id": 1,
        "state": "disabled"
    }
}

Site Hacked

We want to ensure the security of your website, and for that reason, we have implemented a policy where any site marked as hacked will be temporarily disabled. Please note that only a Customer Support team member can mark the site safe again, which will restore its functionality. Once the necessary steps have been taken to resolve any security issues, a Customer Support team member will mark the site safe again, and it will be fully functional.

{
    "event": "site_hacked",
    "site": {
        "id": 1,
        "state": "disabled",
        "status": "hacked"
    }
}

Site Restore Success

Sent when a site has been restored successfully

{
    "event": "site_restored",
    "site": {
        "id": 1
    },
    "restore": {
        "restored_by": "Tom Doe [tomdoe@pressable.dev]",
        "database_id": "3340580943",
        "filesystem_id": "3340580943",
        "requested_at": "2023-03-14T18:05:36.673Z",
        "requested_at_timestamp": 1678817136,
        "completed_at": "2023-03-14T21:05:36.000Z",
        "completed_at_timestamp": 1678827936
    }
}

Site Restore Failed

Sent when a site restore has failed

{
    "event": "site_restore_failed",
    "site": {
        "id": 1
    },
    "restore": {
        "restored_by": "Tom Doe [tomdoe@pressable.dev]",
        "database_id": "3340580943",
        "filesystem_id": "3340580943",
        "requested_at": "2023-03-14T18:05:36.673Z",
        "requested_at_timestamp": 1678817136,
        "failed_at": "2023-03-14T21:05:36.000Z",
        "failed_at_timestamp": 1678827936,
        "error": "SSH connection failed"
    }
}

Site Sync Success

Sent when a site has been synced successfully

{
  "event": "sync_success",
  "from_site_id": 3,
  "to_site_id": 1,
  "restore_sync_request": {
    "message": "Sync completed successfully",
    "status": "completed",
    "requested_by": "Tom Doe [tomdoe@pressable.dev]",
  }
}

Site Sync Failed

Sent when a site sync has failed

{
  "event": "sync_failed",
  "from_site_id": 3,
  "to_site_id": 1,
  "restore_sync_request": {
    "message": "Unable to rollback filesystem due to sync failure, restore site filesystem and database manually",
    "status": "failed",
    "error": "SSH connection failed",
    "failed_at": 1690235593,
    "requested_by": "Tom Doe [tomdoe@pressable.dev]",
  }
}

Site SSH Command

Sent when a site has run an SSH command

{
  "event": "ssh_command",
  "site_id": 1,
  "result": {
    "message": "Command [ wp role create employee Employee ] :::: Success: Role with key 'employee' created.\n",
    "command": "wp role create employee Employee"
  }
}

Site Maintenance Mode

Sent when a site has been toggled into or out of maintenance mode

{
  "event": "maintenance_mode",
  "site_id": 1,
  "maintenance_mode": "enabled | disabled"
}

Site Plugin Installed Successfully

Sent when a Plugin is installed successfully for a site. Version is returned as `latest` if no version was specified.

{
  "event": "plugin_installed",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite",
    "version": "1.8.0.2"
  }
}

Site Plugin Install Failed

Sent when a Plugin fails to install for a site. Version is returned as `latest` if no version was specified.

{
  "event": "plugin_install_failed",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite-v23",
    "version": "latest"
  },
  "error": {
    "message": "Plugin slug not found in WordPress repository - wpforms-lite-v23"
  }
}

Site Plugin Updated Successfully

Sent when a Plugin is successfully updated for a site. Version is returned as `latest` if no version was specified.

{
  "event": "plugin_updated",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite",
    "version": "latest"
  }
}

Site Plugin Update Failed

Sent when a Plugin fails to update for a site. Version is returned as `latest` if no version was specified.

{
  "event": "plugin_update_failed",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite",
    "version": "1.8.0.2"
  },
  "error": {
    "message": "Could not update plugin - wpforms-lite - Error: Can't find the requested plugin's version in the WordPress.org plugin repository (HTTP code 404)"
  }
}

Site Plugin Deactivated Successfully

Sent when a Plugin is successfully deactivated for a site.

{
  "event": "plugin_deactivated",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite"
  }
}

Site Plugin Deactivation Failed

Sent when a Plugin fails to deactivate for a site.

{
  "event": "plugin_deactivation_failed",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite"
  },
  "error": {
    "message": "Could not deactivate plugin - wpforms-lite - Error: No plugins deactivated"
  }
}

Site Plugin Activated Successfully

Sent when a Plugin is successfully activated for a site.

{
  "event": "plugin_activated",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite"
  }
}

Site Plugin Activation Failed

Sent when a Plugin fails to activate for a site.

{
  "event": "plugin_activation_failed",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite"
  },
  "error": {
    "message": "Could not activate plugin - wpforms-lite - Error: No plugins activated"
  }
}

Site Plugin Deleted Successfully

Sent when a Plugin is successfully deleted for a site.

{
  "event": "plugin_deleted",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite"
  }
}

Site Plugin Delete Failed

Sent when a Plugin fails to delete for a site.

{
  "event": "plugin_delete_failed",
  "site": {
    "id": 1
  },
  "plugin": {
    "path": "wpforms-lite"
  },
  "error": {
    "message": "Could not delete plugin - wpforms-lite - Error: There has been a critical error on this website"
  }
}

Site Theme Installed Successfully

Sent when a Theme is installed successfully for a site. Version is returned as `latest` if no version was specified.

{
  "event": "theme_installed",
  "site": {
    "id": 1
  },
  "theme": {
    "path": "astra",
    "version": "3.0.1"
  }
}

Site Theme Install Failed

Sent when a Theme fails to install for a site. Version is returned as `latest` if no version was specified.

{
  "event": "theme_install_failed",
  "site": {
    "id": 1
  },
  "theme": {
    "path": "astra-lite-2",
    "version": "latest"
  },
  "error": {
    "message": "Theme slug not found in WordPress repository - astra-lite-2"
  }
}

Site Theme Updated Successfully

Sent when a Theme is successfully updated for a site. Version is returned as `latest` if no version was specified.

{
  "event": "theme_updated",
  "site": {
    "id": 1
  },
  "theme": {
    "path": "astra",
    "version": "latest"
  }
}

Site Theme Update Failed

Sent when a Theme fails to update for a site. Version is returned as `latest` if no version was specified.

{
  "event": "theme_update_failed",
  "site": {
    "id": 1
  },
  "theme": {
    "path": "astra",
    "version": "4.1.0"
  },
  "error": {
    "message": "Could not update theme - astra - Error: Can't find the requested theme's version in the WordPress.org theme repository (HTTP code 404)"
  }
}

Site Theme Activated Successfully

Sent when a Theme is successfully activated for a site.

{
  "event": "theme_activated",
  "site": {
    "id": 1
  },
  "theme": {
    "path": "astra"
  }
}

Site Theme Activation Failed

Sent when a Theme fails to activate for a site.

{
  "event": "theme_activation_failed",
  "site": {
    "id": 1
  },
  "theme": {
    "path": "astra"
  },
  "error": {
    "message": "Could not activate theme - astra - Error: No themes activated"
  }
}

Site Theme Deleted Successfully

Sent when a Theme is successfully deleted for a site.

{
  "event": "theme_deleted",
  "site": {
    "id": 1
  },
  "theme": {
    "path": "astra"
  }
}

Site Theme Delete Failed

Sent when a Theme fails to delete for a site.

{
  "event": "theme_delete_failed",
  "site": {
    "id": 1
  },
  "theme": {
    "path": "astra"
  },
  "error": {
    "message": "Could not delete theme - astra - Error: There has been a critical error on this website"
  }
}

Git Deploy Completed

Sent when Git deploy completes successfully

{
    "event": "git_deploy_completed",
    "site": {
        "id": 1
    },
    "git": {
        "before": "9dd0f047",
        "after": "13407c6d",
        "name": "john",
        "email": "user@user.com",
        "created_at": "2023-04-11T18:05:38.000Z",
        "created_at_timestamp": 1681236338,
        "repository": "https://github.com/Pressable/test.git",
        "branch": "master",
        "state": "deployed",
        "message": "null"
    }
}

Git Deploy Failed

Sent when Git deploy fails

{
  "event": "git_deploy_failed",
  "site": {
    "id": 1
  },
  "git": {
    "error": {
      "message": "Could not execute a Git deploy for my-presssable-net [1] - invalid auth token"
    }
  }
}

PHP Version Changed

Sent when a site's PHP version is changed

{
    "event": "php_version_changed",
    "site": {
        "id": 1,
        "state": "live",
        "php_version": 8.0
    }
}

WP Environment Type

Sent when a site's WP Environment Type is changed

{
    "event": "wp_environment_type_changed",
    "site": {
        "id": 1,
        "state": "live",
        "wp_environment_type": "staging"
    }
}

WordPress Version Changed

Sent when a site's WordPress Version is changed

{
    "event": "wordpress_version_changed",
    "site": {
        "id": 1,
        "state": "live",
        "wp_version": "beta",
        "wp_version_text": "Latest Release (Beta)"
    }
}

WordPress Admin Password Reset

Sent when a WordPress Admin User Password has been reset

{
    "event": "wordpress_admin_password_reset",
    "site": {
      "id": 1
    },
    "user": {
      "email": "user@email.com"
    }
}

Light Weight 404 Setting Changed

Sent when a site's Light Weight 404 setting is enabled, or disabled

{
    "event": "light_weight_404_changed",
    "site": {
        "id": 1,
        "state": "live",
        "light_weight_404_changed": "enabled"
    }
}

Collaborator Added

Sent when a collaborator is added to a site

{
    "event": "collaborator_added",
    "site": {
        "id": 1
    },
    "collaborator": {
        "id": 1,
        "email": "user@user.com"
    }
}

Collaborator Deleted

Sent when a collaborator is deleted from a site

{
    "event": "collaborator_deleted",
    "site": {
        "id": 1
    },
    "collaborator": {
        "id": 1,
        "email": "user@user.com"
    }
}

SFTP User Password Reset

Sent when an SFTP User password has been reset

{
    "event": "sftp_user_password_reset",
    "site": {
      "id": 1
    },
    "sftp": {
      "username": "john"
    }
}

On-Demand Backup Created

Sent when an On-Demand backup is created for a site

{
    "event": "ondemand_backup_created",
    "backup": {
        "id": "50567",
        "requestId": 505674,
        "type": "fs",
        "status": "created",
        "created_at": "2023-05-01T16:21:07.603Z",
        "created_at_timestamp": 1682958067,
        "system_delete_at": "2023-05-31T16:22:05.000Z",
        "system_delete_at_timestamp": 1685550125,
        "created_by":"John Doe [user@user.com]"
    },
    "site": {
        "id": 1223013
    }
}

On-Demand Backup Deleted

Sent when an On-Demand backup is deleted from a site

{
    "event": "ondemand_backup_deleted",
    "backup": {
        "id": "5056740232",
        "status": "deleted",
        "type": "fs",
        "deleted_by": "John Doe [user@user.com]",
        "deleted_at": "2023-05-01T16:31:03.000Z",
        "deleted_at_timestamp": 1682958663
    },
    "site": {
        "id":1
    }
}

Enabled Edge Cache

Sent when Edge Cache is enabled for a site

{
  "event": "enabled_edge_cache",
  "site": {
    "id": 5
  },
  "user": {
    "email": "user@user.com"
  }
}

Disabled Edge Cache

Sent when Edge Cache is disabled for a site

{
  "event": "disabled_edge_cache",
  "site": {
    "id": 5
  },
  "user": {
    "email": "user@user.com"
  }
}

Purged Edge Cache

Sent when Edge Cache is purged for a site

{
  "event": "purged_edge_cache",
  "site": {
    "id": 5
  },
  "user": {
    "email": "user@user.com"
  }
}

Edge Cache Defensive Mode

Sent when Edge Cache Defensive Mode action is used to activate or deactivate defensive mode for a site

{
  "event": "edge_cache_defensive_mode",
  "site": {
    "id": 5
  },
  "edge_cache": {
    "enabled": true,
    "defensive_mode": true,
    "defensive_mode_until": 1720882555
  }
}

Primary Domain Set

Sent when a site's primary domain has been set. When the primary domain is set to the mystagingwebsite.com domain, the record id will be -1.

{
    "event": "primary_domain_set",
    "site": {
      "id": 1
    },
    "record": {
      "url": "www.domain.com",
      "id": 12
    }
}

Domain Added

Sent when a new domain has been added

{
    "event": "domain_added",
    "site": {
      "id": 1
    },
    "record": {
      "url": "www.domain.com",
      "id": 12
    }
}

Domain Removed

Sent when a domain has been removed

{
    "event": "domain_removed",
    "site": {
      "id": 1
    },
    "record": {
      "url": "www.domain.com",
      "id": 12
    }
}

Must-Use Plugin Install Success

Sent when mu-plugin install completes successfully

{
  "event": "mu_plugin_install_success",
  "site": {
    "id": 1
  },
  "mu_plugin": {
    "id": 1,
    "slug": "pressable-maintenance-mode-plugin.php",
    "path": "https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0",
    "message": "Added mu-plugin pressable-maintenance-mode-plugin.php [ https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0 ]"
  }
}

Must-Use Plugin Install Failed

Sent when mu-plugin install failed

{
  "event": "mu_plugin_install_failed",
  "site": {
    "id": 1
  },
  "mu_plugin": {
    "id": 1,
    "slug": "pressable-maintenance-mode-plugin.php",
    "path": "https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0",
    "message": "Failed to add mu-plugin pressable-maintenance-mode-plugin.php [ https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0 ] - directory not found"
  }
}

Must-Use Plugin Update Success

Sent when mu-plugin update completes successfully

{
  "event": "mu_plugin_update_success",
  "site": {
    "id": 1
  },
  "mu_plugin": {
    "id": 1,
    "slug": "pressable-maintenance-mode-plugin.php",
    "path": "https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0",
    "message": "Updated mu-plugin pressable-maintenance-mode-plugin.php [ https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0 ]"
  }
}

Must-Use Plugin Update Failed

Sent when mu-plugin update failed

{
  "event": "mu_plugin_update_failed",
  "site": {
    "id": 1
  },
  "mu_plugin": {
    "id": 1,
    "slug": "pressable-maintenance-mode-plugin.php",
    "path": "https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0",
    "message": "Failed to update mu-plugin pressable-maintenance-mode-plugin.php [ https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l&dl=0 ] - directory not found"
  }
}

Must-Use Plugin Deleted

Sent when mu-plugin is deleted

{
  "event": "mu_plugin_deleted",
  "site": {
    "id": 1
  },
  "mu_plugin": {
    "id": 1,
    "slug": "pressable-maintenance-mode-plugin.php",
    "message": "Removed mu-plugin [ 1 ] [ pressable-maintenance-mode-plugin.php ]"
  }
}

Site Performance Report Created

Sent when a performance report is created for a site

{
    "event": "performance_report_created",
    "site": {
      "id": 1223013
    },
    "performance_report": {
      "id": 50567,
    }
}

Errors

We use conventional HTTP response codes to indicate the success, or failure, of an API request.

{
    "message": "There was a problem processing your request.",
    "data": null,
    "errors": [
        "Message"
    ]
}

Error Code

Meaning

400

Bad Request

No response body

Error Code

Meaning

401

Unauthorized

{
    "message": "We could not locate the requested resources.",
    "data": null,
    "errors": null
}

Error Code

Meaning

404

Not Found

{
    "message": "An internal error occurred while processing your request. Please try again.",
    "data": null,
    "errors": null
}

Error Code

Meaning

500

Internal Server Error

Job Queues

The Pressable API uses job queues to process long running tasks. These jobs are queued and processed in the background. The API will return a 200 response when a job is queued. The completion notification of enqueued jobs can be monitored via our webhooks.

There are various reasons why jobs may fail, ranging from network problems and WordPress errors to issues with the data itself. In the event of a failure, the queued job system is designed to automatically retry the job 10 times. This retrying process adheres to a specific schedule to ensure optimal reprocessing of the failed job:

1st reattempt: 6 seconds after the initial attempt
2nd reattempt: 20 seconds after the 1st reattempt
3rd reattempt: 1 minute after the 2nd reattempt
4th reattempt: 5 minutes after the 3rd reattempt
5th reattempt: 10 minutes after the 4th reattempt
6th reattempt: 20 minutes after the 5th reattempt
7th reattempt: 40 minutes after the 6th reattempt
8th reattempt: 1 hour after the 7th reattempt
9th reattempt: 2 hours after the 8th reattempt
10th reattempt: 3 hours after the 9th reattempt

curl