{ "opencollection": "1.0.0", "info": { "name": "Pressable API Documentation (v1) account sites API", "version": "1.0.0" }, "items": [ { "info": { "name": "sites", "type": "folder" }, "items": [ { "info": { "name": "DNS Wizard Share-Link Handoff", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/domains/entri_link", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Issues a DNS Wizard share link that an end user follows to point an existing domain at this site. This is the asynchronous companion to the synchronous POST /v1/sites/{site_id}/domains flow — useful when the API caller does not own the domain and needs the actual owner to walk through DNS setup themselves." }, { "info": { "name": "Edge Cache Status", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/edge-cache", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the current status of the edge cache for your site." }, { "info": { "name": "Toggle Edge Cache", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/edge-cache", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "The ability to toggle edge cache allows you to enable or disable caching of your site's content at edge locations." }, { "info": { "name": "Purge Edge Cache", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:id/edge-cache", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Edge Cache Defensive Mode", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/edge-cache/defensive-mode", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Git Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/git", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Return the current git configuration for a site — repository URL, branch, repositorySubdirectory (the directory within the repository to deploy from), destinationPath (the path within the site's document root to deploy into), and whether a token is stored." }, { "info": { "name": "Connect Repository", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/git", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attach a GitHub repository to the site and trigger an initial deploy. The site's account must already have a bearer token stored — call POST /sites/{site_id}/git/token first if it does not." }, { "info": { "name": "Update Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:site_id/git", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the connected branch, destination path, or repository subdirectory on a site that is already connected to git. Omitted fields are left unchanged; pass an explicit empty string to destination_path or repository_subdirectory to clear that field." }, { "info": { "name": "Disconnect Repository", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/git", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Disconnect the repository from the site. The stored bearer token is also cleared for this site (use POST /sites/{site_id}/git/token to restore it before reconnecting)." }, { "info": { "name": "Store Access Token", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/git/token", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Persist a GitHub access token for the site. The token must already be issued by GitHub — Pressable does not exchange OAuth codes on your behalf, and only api.github.com is supported (GitHub Enterprise and other git providers are not). Accepted inputs are a classic Personal Access Token, a fine-grained PAT, or a GitHub OAuth access token (e.g. from a GitHub App installation)." }, { "info": { "name": "Revoke Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/git/token", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Clear the stored bearer token for the current site only. Sibling sites on the same Pressable account keep their token. Account-wide revocation is not exposed by the API; use the Control Panel UI for that." }, { "info": { "name": "List Branches", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/git/branches", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Return the branches available on the connected repository. Useful when building a branch picker against a Pressable site." }, { "info": { "name": "Trigger Deploy", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/git/deploy", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Queue a deploy of the currently configured branch on the connected repository. The endpoint returns 202 Accepted with the deploy identifier; deploy progress is then asynchronous. Poll GET /sites/{site_id}/git/history (or subscribe to the git_deploy_completed and git_deploy_failed webhooks) for the final state." }, { "info": { "name": "Deploy History", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/git/history", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "Return paginated deploy history for the site, newest first. Use this to follow up on a POST /sites/{site_id}/git/deploy call or to inspect deploy outcomes triggered from the UI." }, { "info": { "name": "On-Demand Backup List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/ondemand-backups", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of on-demand backups for the specified site." }, { "info": { "name": "Create On-Demand Backup", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/ondemand-backups", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an on-demand backup for the specified site." }, { "info": { "name": "Get On-Demand Backup", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/ondemand-backups/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the details for a specific on-demand backup attached to the specified site." }, { "info": { "name": "Delete On-Demand Backup", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/ondemand-backups/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Download On-Demand Backup", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/ondemand-backups/:id/download", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Download the specified on-demand backup attached to the specified site." }, { "info": { "name": "Plugin List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/plugins", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of plugins for the specified site." }, { "info": { "name": "Install and Activate Plugins", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/plugins", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To enhance your WordPress site, install and activate plugins to add new features, functionality, and customization options effortlessly." }, { "info": { "name": "Update Plugins", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/plugins", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Regularly updating plugins is crucial for WordPress sites to ensure optimal performance, security, and compatibility with the latest features and enhancements." }, { "info": { "name": "Delete Plugins", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:id/plugins", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deleting unnecessary plugins from WordPress sites enhances performance, reduces security risks, and minimizes conflicts, resulting in a streamlined and efficient website environment." }, { "info": { "name": "Deactivate Plugins", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/plugins/deactivate", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deactivating plugins on WordPress sites allows for troubleshooting, prevents conflicts, and temporarily disables specific functionalities without removing the plugin entirely." }, { "info": { "name": "Activate Plugins", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/plugins/activate", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activating previously deactivated plugins restores desired functionalities, expands features, and re-enables customizations." }, { "info": { "name": "Plugin Alerts", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/security-alerts/plugins", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of plugins reporting security issues" }, { "info": { "name": "Theme Alerts", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/security-alerts/themes", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of themes reporting security issues" }, { "info": { "name": "Site List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites", "params": [ { "name": "paginate", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Get a list of sites belonging to your account. Sites can be filtered by tag name or limited to favorites only. Favorited sites are pinned to the top of the list by default. Site listing is a full list of sites attached to your account, unless pagination is requested." }, { "info": { "name": "Create Site", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new site in your account." }, { "info": { "name": "Validate Site Name", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/validate" }, "docs": "Use this endpoint to check if a site name is valid before attempting to create a site." }, { "info": { "name": "Get Site", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get site information and settings." }, { "info": { "name": "Update Site", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Display Name, PHP Version or WP Environment Type for a site." }, { "info": { "name": "Delete Site", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a site with the specified id." }, { "info": { "name": "Search Sites", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/search", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Site Install Options", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/install-options" }, "docs": "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." }, { "info": { "name": "Available Site Datacenters", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/datacenters" }, "docs": "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." }, { "info": { "name": "Valid PHP Versions", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/php-versions" }, "docs": "Get valid PHP versions that are currently available for sites hosted within our platform." }, { "info": { "name": "Disable Site", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/disable", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Enable Site", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/enable", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Convert Site (Staging/Live)", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/convert", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Staging/Sandbox to Live" }, { "info": { "name": "Convert Site To DupliKit", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/convert/duplikit", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Convert To DupliKit" }, { "info": { "name": "Convert Site To Sandbox", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/convert/sandbox", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Staging to Sandbox" }, { "info": { "name": "Convert Site To Live", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/convert/live", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Coverting to Live" }, { "info": { "name": "Convert Site To Staging", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/convert/staging", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Live to Staging" }, { "info": { "name": "Flush Object Cache", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/object-cache", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Flush the object cache for a site with the specified id." }, { "info": { "name": "Toggle Light Weight 404", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/light_weight_404", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Enable or Disable Light Weight 404 handling for a site with the specified id." }, { "info": { "name": "Toggle Multisite Support", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/multisite-support", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Please note that you must be on a High Traffic Plan to use this feature." }, { "info": { "name": "Maintenance Mode", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/maintenance-mode", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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 " }, { "info": { "name": "Basic Authentication", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/basic-authentication", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "The \"Basic Authentication\" feature allows you to easily restrict public access to your website. When installed, it activates the Pressable Basic Authentication plugin, which requires anyone visiting your site to enter a username and password before gaining access. This is especially useful for in-progress development sites where you want to keep content private. Removing the Basic Authentication plugin removes this login requirement, making your site fully open to the public. Be sure all content" }, { "info": { "name": "WordPress MCP", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/wordpress-mcp", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "The \"WordPress MCP\" feature toggles the WordPress MCP plugin on a per-site basis. When activated, the Pressable WordPress MCP plugin is installed and enabled, exposing the site to Model Context Protocol clients. Deactivating removes the plugin and disables MCP access for the site. The endpoint flips the toggle each time it is called — one call enables, the next disables." }, { "info": { "name": "File Modification Settings", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/file-modifications", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Returns the current state of the wp-config file-modification constants for a site. ‘disallow_file_edit’ reports the DISALLOW_FILE_EDIT constant (hides the built-in plugin & theme code editor in the WordPress admin) and ‘disallow_file_mods’ reports the DISALLOW_FILE_MODS constant (also blocks plugin/theme installs, updates, and deletions)." }, { "info": { "name": "Update File Modification Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:site_id/file-modifications", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets or removes a wp-config file-modification constant for a site. When ‘enabled’ is true the constant is defined as ‘true’ in the site’s wp-config.php; when false the constant is removed. Removing an already-absent constant succeeds, so the disable path is idempotent." }, { "info": { "name": "Favorite Site", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/favorites", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Add a site to your site favorites, favorite sites show up first in site listings." }, { "info": { "name": "Unfavorite Site", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/favorites", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Remove a site as a favorite with the specified site id." }, { "info": { "name": "Create Site Clone", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/clone", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a copy of the specified site." }, { "info": { "name": "Backups List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/backups", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Get a list of available site backups for the specified site." }, { "info": { "name": "Filesystem Backups List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/backups/fs", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Get a list of available site filesystem backups for the specified site." }, { "info": { "name": "Database Backups List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/backups/db", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Get a list of available site database backups for the specified site." }, { "info": { "name": "Get Site Backup", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/backups/:backup_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "backup_id", "value": "", "type": "path" } ] }, "docs": "Download a specified site backup" }, { "info": { "name": "Site Filesystem & Database Restores", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/restores", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Site Restore Status", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/restores/:restore_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "restore_id", "value": "", "type": "path" } ] }, "docs": "Poll the progress of a restore started with POST /sites/{site_id}/restores. MPCP shows this progress live in the UI; these read-only endpoints return the same status and per-line log messages . The list endpoint returns a site's restores newest-first, so the most recent restore is the first entry." }, { "info": { "name": "Data Transfer", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/sync", "body": { "type": "json", "data": "{}" } }, "docs": "Data Transfer 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 transfer you prefer - you can opt to transfer:" }, { "info": { "name": "Collaborator List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/collaborators", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Get a list of collaborators for the specified site." }, { "info": { "name": "Create Site Collaborator", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/collaborators", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new collaborator with the specified email on the specified site." }, { "info": { "name": "Get Site Collaborator", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/collaborators/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get site collaborator information." }, { "info": { "name": "Delete Collaborator", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/collaborators/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a collaborator with the specified id." }, { "info": { "name": "Set Collaborator WP-Admin Password", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:site_id/collaborators/:id/wp-password-reset", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Domain List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/domains", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Get a list of domains for a given site." }, { "info": { "name": "Add Domain", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/domains", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new domain to a site." }, { "info": { "name": "Get Domain", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/domains/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get domain information." }, { "info": { "name": "Delete Domain", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/domains/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a domain from a site." }, { "info": { "name": "Set Primary Domain", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:site_id/domains/:id/primary", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set a domain as the primary domain. All other ARecord domains attached to your site will redirect to the primary domain." }, { "info": { "name": "Get SFTP User List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/ftp", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Get a list of FTP users for the specified site." }, { "info": { "name": "Get SFTP User", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/ftp/:username", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Get SFTP user by Id for the specified site." }, { "info": { "name": "Reset SFTP User Password", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/ftp/password/:username", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Reset an FTP user password for the specified user and site." }, { "info": { "name": "Jetpack License Information", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/jetpack", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Get the Jetpack license information for the specified site." }, { "info": { "name": "Set Jetpack License", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/jetpack", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "When setting the Jetpack license on your site, the license will be set in the WP Options table for your site." }, { "info": { "name": "Statistics", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/statistics", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Get a list of statistics for a site. Data is updated once daily." }, { "info": { "name": "Add Tags", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/tags", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Remove Tags", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:id/tags", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove tags from your site." }, { "info": { "name": "Note List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/notes", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Get the notes attached to the requested site." }, { "info": { "name": "Add Note", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/notes", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add notes to your site." }, { "info": { "name": "Get Note", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/notes/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get specified note for site." }, { "info": { "name": "Update Note", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:site_id/notes/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update note for your site." }, { "info": { "name": "Delete Note", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/notes/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a note from your site." }, { "info": { "name": "Reset WP-Admin Password", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:site_id/wordpress/password-reset", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Get phpMyAdmin URL for Site", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/wordpress/phpmyadmin", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Update WordPress Version for Site", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:site_id/wordpress/version", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "One Press Login", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/one_press_login", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a one time url to sign-in to one of your WordPress sites as the user specified by the given email." }, { "info": { "name": "PHP Error Logs", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/logs/php", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "scroll_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Web Server Logs", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/logs/server", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "scroll_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "request_type", "value": "", "type": "query" }, { "name": "user_ip", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Activity Logs", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/logs/activity", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Disconnect SSH", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/disconnect-ssh", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Terminate all SSH connections for a site." }, { "info": { "name": "Latest Performance Report", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/reports/performance/latest", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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 ." }, { "info": { "name": "Site Usage Report", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/reports/usage", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the usage details for a given site. Storage values in the *_storage_usage_in_gigabytes fields are binary gibibytes (GiB, 1024³ bytes); the field names are kept for compatibility." }, { "info": { "name": "Site Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve time series metrics for a given site." }, { "info": { "name": "Set PHP File System Permissions", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/php_fs_permissions", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "PHP FS Permissions control how a site's filesystem is mounted during PHP-handled HTTP requests. This setting determines whether PHP can read from and/or write to the site's files." }, { "info": { "name": "List Egress Firewall Rules", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/firewall_rules", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "List the egress firewall rules for a site" }, { "info": { "name": "Show Egress Firewall Rules", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:site_id/firewall_rules/:firewall_rule_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "firewall_rule_id", "value": "", "type": "path" } ] }, "docs": "Show an egress firewall rules for a site" }, { "info": { "name": "Delete Egress Firewall Rules", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/firewall_rules/:firewall_rule_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "firewall_rule_id", "value": "", "type": "path" } ] }, "docs": "Delete an egress firewall rule for a site" }, { "info": { "name": "Create Egress Firewall Rule", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/firewall_rules/create", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an egress firewall rule for a site" }, { "info": { "name": "Refresh Egress Firewall Rules", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/firewall_rules/refresh", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Refresh egress firewall rules for a site" }, { "info": { "name": "Activate APM", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/apm/activate", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate Application Performance Monitoring for a site" }, { "info": { "name": "Deactivate APM", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:site_id/apm/deactivate", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Deactivate Application Performance Monitoring for a site" }, { "info": { "name": "Cron Jobs", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:site_id/cron_jobs/:id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Manage scheduled tasks (cron jobs) for your site." }, { "info": { "name": "Set Filesystem Usage Limit", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/usage/filesystem", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set a maximum filesystem usage limit for your site along with a warning threshold. When site storage approaches or exceeds these limits, you'll receive alerts. Setting these limits helps you proactively manage your site's storage." }, { "info": { "name": "Set Database Usage Limit", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/usage/database", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set a maximum database usage limit for your site along with a warning threshold. These limits help you monitor database growth and receive alerts when approaching capacity constraints." }, { "info": { "name": "Theme List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/themes", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of themes for the specified site." }, { "info": { "name": "Install and Activate Themes", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/themes", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update Themes", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/themes", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete Themes", "type": "http" }, "http": { "method": "DELETE", "url": "https://my.pressable.com/v1/sites/:id/themes", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Activate Themes", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/themes/activate", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "WordPress User List", "type": "http" }, "http": { "method": "GET", "url": "https://my.pressable.com/v1/sites/:id/wordpress/users", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "This endpoint retrieves a list of WordPress users from your site." }, { "info": { "name": "Create WordPress User", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/wordpress/users", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update WordPress User Password", "type": "http" }, "http": { "method": "PUT", "url": "https://my.pressable.com/v1/sites/:id/wordpress/users/password-reset", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows for the modification of a WordPress user's password directly on your site." }, { "info": { "name": "WP-CLI Commands", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/wordpress/wpcli", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows you to run WP-CLI commands via the API. WP-CLI is the command-line interface for WordPress." }, { "info": { "name": "Bash Commands", "type": "http" }, "http": { "method": "POST", "url": "https://my.pressable.com/v1/sites/:id/wordpress/commands", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows you to run Bash commands via the API." } ] } ], "bundled": true }