[{"title":"Introduction","description":"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.","actions":[]},{"title":"Authentication","description":"OAuth authentication using a provided client id and client secret, which are supplied in the control panel.","actions":[{"title":"Obtain Access Token","description":"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.","request":"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\"'","response":{"access_token":"tXJSK-RX1GxSPyjLNvz7TkXwl1SuWoKgp4mwQYg5GjM","token_type":"Bearer","expires_in":3599,"scope":"authorized","created_at":1686949418,"id":1,"name":"John Doe","email":"[email protected]","gravatar":"https://www.gravatar.com/avatar/3b0e9a78b5621fce924f7ce107180970371cf75f565dfaa5e4babe2e4866422a?d=mp","scopes":["authorized","owner"]}},{"title":"Revoke Access Token","description":"Revoke an access token to stop the access token from being able to make API requests.","request":"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\"'","response":"No response body"}]},{"title":"Account","description":"Account profile and settings information.","actions":[{"title":"Account Details","description":"Get your account profile information.","request":"curl --location --request GET 'https://my.pressable.com/v1/account' --header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8DnJskv4'","response":{"message":"Success","data":{"affiliate":false,"collaboratorCount":0,"email":"[email protected]","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}},{"title":"Set Account PHP Version","description":"Set a default PHP version for all new sites created in your account.","request":"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\"}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Set Account Datacenter","description":"Set a default Datacenter for all new sites created in your account.","request":"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\"}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Account Activity Logs","description":"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.","request":"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\": \"[email protected]\" } ] }'","response":{"message":"Success","data":[{"id":2243,"timestamp":"2023-10-13T20:11:57.216Z","accountEmail":"[email protected]","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":"[email protected]","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":"[email protected]","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":"[email protected]","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":"[email protected]","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":"[email protected]","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":"[email protected]","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}},{"title":"Account Activity Log Actions","description":"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.","request":"curl --location --request GET 'https://my.pressable.com/v1/activity/account-actions' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz'","response":{"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}},{"title":"Get List of Available Account Add-ons","description":"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.","request":"curl --location --request GET 'https://my.pressable.com/v1/account/addons' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz'","response":{"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}},{"title":"Get List of Add-ons Attached to Your Account","description":"View the add-ons linked to your account that extend your plan with extra sites, more site visits, and increased storage capacity.","request":"curl --location --request GET 'https://my.pressable.com/v1/account/addons/attached' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz'","response":{"message":"Success","data":[{"name":"1 Site","quantity":1},{"name":"10K Site Visits","quantity":1},{"name":"10GB Site Storage","quantity":1}],"errors":null}},{"title":"Update Add-ons Attached to Your Account","description":"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:","request":"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}'","response":{"message":"Success","data":[{"name":"1 Site","quantity":5},{"name":"10K Site Visits","quantity":5},{"name":"10GB Site Storage","quantity":5}],"errors":null}}]},{"title":"Collaborators","description":"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.","actions":[{"title":"Get Collaborator","description":"Get collaborator information for the specified collaborator.","request":"curl --location --request GET 'https://my.pressable.com/v1/collaborators/{id}' --header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw'","response":{"message":"Success","data":{"id":757,"created":"2023-05-12T21:43:31.000Z","updated":"2023-05-12T21:43:31.000Z","accountId":1419361,"email":"[email protected]","siteId":1268,"state":"active","wpUsername":"[email protected]","name":"[email protected]","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}},{"title":"Update Account Level Access","description":"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.","request":"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\": \"[email protected]\", \"add_to_all_new\": true, \"create_site\": true, \"roles\": [ \"clone_site\", \"update_site_custom_name\" ]}'","response":{"message":"Success","data":{"email":"[email protected]","add_to_all_new":true,"create_site":true},"errors":null}},{"title":"Bulk Create / Update","description":"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.","request":"curl --location --request POST 'https://my.pressable.com/v1/collaborators/batch_create' --header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8DnJskv4' --header 'Content-Type: application/json' --data-raw '{ \"email\": \"[email protected]\", \"siteIds\": [ 2, 100, 500 ], \"roles\": [ \"clone_site\", \"update_site_custom_name\" ]}'","response":{"message":"Collaborator creation scheduled for 2 sites","data":null,"errors":null}},{"title":"Bulk Delete","description":"Removes a collaborator with the provided email address from a list of sites.","request":"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\": \"[email protected]\", \"delete_wp_user\": true, \"siteIds\": [ 10, 20, 50 ]}'","response":{"message":"Collaborator removal scheduled for 3 sites","data":null,"errors":null}},{"title":"Get Site","description":"Get a specific site that belongs to the specified collaborator.","request":"curl --location --request GET 'https://my.pressable.com/v1/collaborators/{collaborator_id}/site' --header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw'","response":{"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}},{"title":"Add Site Tag","description":"Create tags for a collaborator on their site.","request":"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\" ]}'","response":{"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}},{"title":"Delete Site Tag","description":"Delete site tags with the specified site tag ids on a site for a collaborator.","request":"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 ]}'","response":{"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}},{"title":"Site List using Email Address","description":"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.","request":"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}'","response":{"message":"Success","data":{"name":"Claire Doe","email":"[email protected]","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}},{"title":"Get Site using Email Address","description":"Get a site attached to a collaborator.","request":"curl --location --request GET 'https://my.pressable.com/v1/collaborators/{email_address}/sites/{site_id}' --header 'Authorization: Bearer BxrdfyKaV4JKR8zVbVHHl1iqdWoVn-L9oUE2Fl9oMtw'","response":{"message":"Success","data":{"name":"Claire Doe","email":"[email protected]","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}},{"title":"Add Site as Favorite","description":"Add a site to collaborator site favorites. Favorite sites show up first in collaborator site listings.","request":"curl --location --request POST 'https://my.pressable.com/v1/collaborators/{email_address}/sites/{site_id}/favorite' --header 'Authorization: Bearer 9m11x6zrCUe7SKMME2dKjF4DrUGHTS8CC6rk-z1_P_M'","response":{"message":"Success","data":{"name":"Claire Doe","email":"[email protected]","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}},{"title":"Remove Site as Favorite","description":"Remove a site from a collaborators list of site favorites.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/collaborators/{email_address}/sites/{site_id}/favorite' --header 'Authorization: Bearer 9m11x6zrCUe7SKMME2dKjF4DrUGHTS8CC6rk-z1_P_M'","response":{"message":"Success","data":{"name":"Claire Doe","email":"[email protected]","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}},{"title":"Add Site Tag using Email Address","description":"Add tags to a collaborator’s site using the collaborator's email address.","request":"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\" ]}'","response":{"message":"Success","data":{"name":"Claire Doe","email":"[email protected]","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}},{"title":"Remove Site Tag using Email Address","description":"Remove tags from collaborator’s site using collaborator's email address.","request":"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 ]}'","response":{"message":"Success","data":{"name":"Claire Doe","email":"[email protected]","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}}]},{"title":"DNS","description":"Manage DNS through the Pressable API.","actions":[{"title":"Get Zones","description":"Get the zones attached to your account.","request":"curl --location --request GET 'https://my.pressable.com/v1/zones' --header 'Authorization: Bearer ob9TDvE07rXgUpVVZdNCNWIUYCDVghy8dZr1u2gH-o4'","response":{"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}},{"title":"Get Zone Records","description":"Returns all the DNS records attached to a zone.","request":"curl --location --request GET 'https://my.pressable.com/v1/zones/{zone_id}/records' --header 'Authorization: Bearer ob9TDvE07rXgUpVVZdNCNWIUYCDVghy8dZr1u2gH-o4'","response":{"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}},{"title":"Create Zone Record","response":{"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},"request":"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}'"},{"title":"Delete Record","description":"Delete a DNS record from a zone.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/zones/{zone_id}/records/{id}' --header 'Authorization: Bearer ob9TDvE07rXgUpVVZdNCNWIUYCDVghy8dZr1u2gH-o4'","response":{"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}},{"title":"Generate Email Provider Records","description":"Generate all the email records for popular providers. The records will be attached to the requested zone.","request":"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\"}'","response":{"message":"Success","data":null,"errors":null}},{"title":"SSL Certificate Details","description":"Returns the SSL certificate details for an A Record.","request":"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'","response":{"message":"No information found","data":null,"errors":["No information found"]}},{"title":"Retry SSL Certificate Provisioning","description":"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.","request":"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'","response":{"message":"There was a problem processing your request.","data":null,"errors":["SSL can only be retried on A records"]}}]},{"title":"Edge Cache","description":"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.","actions":[{"title":"Edge Cache Status","description":"Get the current status of the edge cache for your site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/edge-cache' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"message":"Success","data":{"active":true,"defensive_mode":{"active":true,"active_until":1724951720}},"errors":null}},{"title":"Toggle Edge Cache","description":"The ability to toggle edge cache allows you to enable or disable caching of your site's content at edge locations.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/edge-cache' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"message":"Success","data":null,"errors":null}},{"title":"Purge Edge Cache","description":"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.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/edge-cache' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"message":"Success","data":null,"errors":null}},{"title":"Edge Cache Defensive Mode","description":"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.","request":"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\"}'","response":{"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}}]},{"title":"Must-Use Plugins","description":"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.","actions":[{"title":"Get Must-Use Plugin List","description":"Get a list of your mu-plugins.","request":"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}'","response":{"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\u0026dl=0","slug":"mu-plugin.php"}],"page":{"currentPage":1,"nextPage":null,"lastPage":1,"perPage":20,"totalItems":2},"errors":null}},{"title":"Get Must-Use Plugin","description":"Get details about your mu-plugin.","request":"curl --location --request GET 'https://my.pressable.com/v1/mu-plugins/{id}' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"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}},{"title":"Create / Install Must-Use Plugin","description":"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.","request":"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}'","response":{"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}},{"title":"Update Must-Use Plugin","description":"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.","request":"curl --location --request PUT 'https://my.pressable.com/v1/mu-plugins/{id}' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"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}},{"title":"Delete Must-Use Plugin","description":"This action will delete the mu-plugin identified by the given ID and remove it from all sites in your account.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/mu-plugins/{id}' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"message":"Success","data":null,"errors":null}}]},{"title":"On-Demand Backups","description":"Create your own backups of your site's filesystem and database.","actions":[{"title":"On-Demand Backup List","description":"Get a list of on-demand backups for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/ondemand-backups' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"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 ([email protected])","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 ([email protected])","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 ([email protected])","removedIn":"6 days and 22 hours from now","deleteAt":1683562925}],"errors":null}},{"title":"Create On-Demand Backup","description":"Create an on-demand backup for the specified site.","request":"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\"}'","response":{"message":"Success","data":{"id":null,"requestId":50564,"siteId":1223013,"completed":null,"status":"creating","type":"fs","bytes":null,"requested":1682966700,"backupTimestamp":null,"createdBy":"John Doe ([email protected])","removedIn":"30 days and 0 hours from now","deleteAt":1685558700},"errors":null}},{"title":"Get On-Demand Backup","description":"Get the details for a specific on-demand backup attached to the specified site.","request":"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'","response":{"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 ([email protected])","removedIn":"29 days and 21 hours from now","deleteAt":1685546944},"errors":null}},{"title":"Download On-Demand Backup","description":"Download the specified on-demand backup attached to the specified site.","request":"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'","response":{"message":"string","errors":["string"]}},{"title":"Delete On-Demand Backup","description":"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.","request":"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'","response":{"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 ([email protected])","removedIn":"29 days and 21 hours from now","deleteAt":1685546944},"errors":null}}]},{"title":"Plugins","description":"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.","actions":[{"title":"Plugin List","description":"Get a list of plugins for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/plugins' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"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}},{"title":"Install and Activate Plugins","description":"To enhance your WordPress site, install and activate plugins to add new features, functionality, and customization options effortlessly.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Update Plugins","description":"Regularly updating plugins is crucial for WordPress sites to ensure optimal performance, security, and compatibility with the latest features and enhancements.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Deactivate Plugins","description":"Deactivating plugins on WordPress sites allows for troubleshooting, prevents conflicts, and temporarily disables specific functionalities without removing the plugin entirely.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Activate Plugins","description":"Activating previously deactivated plugins restores desired functionalities, expands features, and re-enables customizations.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Delete Plugins","description":"Deleting unnecessary plugins from WordPress sites enhances performance, reduces security risks, and minimizes conflicts, resulting in a streamlined and efficient website environment.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}}]},{"title":"Sites","description":"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.","actions":[{"title":"Site List","description":"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":"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}'","response":"{ \"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}"},{"title":"Create Site","description":"Create a new site in your account.","request":"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\": \"[email protected]\"}'","response":"{ \"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}"},{"title":"Validate Site Name","description":"Use this endpoint to check if a site name is valid before attempting to create a site.","request":"curl --location --request POST 'https://my.pressable.com/v1/sites/validate' --header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8'","response":{"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}},{"title":"Get Site","description":"Get site information and settings.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{id}' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh'","response":"{ \"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\": \"[email protected]\", \"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\": \"[email protected]\", \"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\": \"[email protected]\", \"gravatar\": \"https://www.gravatar.com/avatar/595f525cba4a637978bc1ab2899f1d52?d=mp\", \"name\": \"Claire Doe\", \"wpUsername\": \"johndoe\", \"username\": null } ], \"jetpack\": null }, \"errors\": null}"},{"title":"Update Site","description":"Update the Display Name, PHP Version or WP Environment Type for a site.","request":"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\"}'","response":"{ \"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}"},{"title":"Delete Site","description":"Delete a site with the specified id.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}' --header 'Authorization: Bearer cjh02WI6u4j4QpKZeKFCAGF9uLINWTXlj9y8Dn'","response":{"message":"Success","data":null,"errors":null}},{"title":"Search Sites","description":"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.","request":"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}'","response":{"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}},{"title":"Site Install Options","description":"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.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/install-options' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":["wordpress","woocommerce"],"errors":null}},{"title":"Available Site Datacenters","description":"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.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/datacenters' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3434'","response":{"message":"Success","data":[{"code":"BUR","name":"Los Angeles, CA, USA"},{"code":"DCA","name":"Washington, DC, USA"},{"code":"DFW","name":"Dallas, TX, USA"}],"errors":null}},{"title":"Valid PHP Versions","description":"Get valid PHP versions that are currently available for sites hosted within our platform.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/php-versions' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34'","response":{"message":"Success","data":["8.1","8.2","8.3","8.4"],"errors":null}},{"title":"Disable Site","description":"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.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/disable' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3434'","response":{"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}},{"title":"Enable Site","description":"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.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/enable' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34'","response":"{ \"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}"},{"title":"Convert Site (Staging/Live)","description":"Staging to Live","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/convert' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34'","response":"{ \"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\": \"[email protected]\", \"gravatar\": \"https://www.gravatar.com/avatar/595f525cba4a637978bc1ab2899f1d52?d=mp\", \"name\": \"Claire Doe\", \"wpUsername\": \"johndoe\", \"username\": null } ], \"jetpack\": null }, \"errors\": null}"},{"title":"Clear CDN Cache","description":"Clear the CDN cache for a site with the specified id.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/cache' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh34347g'","response":{"message":"Success","data":null,"errors":null}},{"title":"Get CDN Status","description":"Get the CDN status for a site with the specified id. The status can be either enabled or disabled.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/cdn' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":{"cdnEnabled":true},"errors":null}},{"title":"Enable CDN","description":"Enable the CDN for a site with the specified id.","request":"curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/cdn' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":{"cdnEnabled":true},"errors":null}},{"title":"Disable CDN","description":"Disable the CDN for a site with the specified id.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/sites/{id}/cdn' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":{"cdnEnabled":false},"errors":null}},{"title":"Toggle CDN","description":"Enable or Disable the CDN for a site with the specified id.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/cdn' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":{"cdnEnabled":true},"errors":null}},{"title":"Flush Object Cache","description":"Flush the object cache for a site with the specified id.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/object-cache' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":null,"errors":null}},{"title":"Toggle Light Weight 404","description":"Enable or Disable Light Weight 404 handling for a site with the specified id.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/light_weight_404' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":{"lightWeight404Enabled":true},"errors":null}},{"title":"Toggle Multisite Support","description":"Please note that you must be on a High Traffic Plan to use this feature.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/multisite-support' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"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}},{"title":"Maintenance Mode","description":"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.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{id}/maintenance-mode' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":null,"errors":null}},{"title":"Favorite Site","description":"Add a site to your site favorites, favorite sites show up first in site listings.","request":"curl --location --request POST 'https://my.pressable.com/v1/sites/{id}/favorites' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":null,"errors":null}},{"title":"Unfavorite Site","description":"Remove a site as a favorite with the specified site id.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/favorites' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh3'","response":{"message":"Success","data":null,"errors":null}},{"title":"Create Site Clone","description":"Create a copy of the specified site.","request":"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\"}'","response":"{ \"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}"},{"title":"Backups List","description":"Get a list of available site backups for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/backups' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'","response":{"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}},{"title":"Filesystem Backups List","description":"Get a list of available site filesystem backups for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/backups/fs' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'","response":{"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}},{"title":"Database Backups List","description":"Get a list of available site database backups for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/backups/db' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'","response":{"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}},{"title":"Get Site Backup","description":"Download a specified site backup","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/backups/{backup_id}' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'","response":"Response Stream"},{"title":"Site Filesystem \u0026 Database Restores","description":"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.","request":"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}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Data Sync","description":"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:","request":"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\"}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Collaborator List","description":"Get a list of collaborators for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/collaborators' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzv'","response":{"message":"Success","data":[{"id":1,"created":"2022-01-31T20:05:39.000Z","updated":"2022-01-31T20:05:39.000Z","accountId":3,"email":"[email protected]","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":"[email protected]","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":"[email protected]","siteId":1,"state":"active","wpUsername":"johndoe","name":"Claire Doe","siteName":"my-presssable-net"}],"errors":null}},{"title":"Create Site Collaborator","description":"Create a new collaborator with the specified email on the specified site.","request":"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\": \"[email protected]\", \"roles\": [ \"clone_site\", \"update_site_custom_name\" ]}'","response":{"message":"Success","data":{"id":1303,"created":"2022-02-18T16:25:46.000Z","updated":"2022-02-18T16:25:47.000Z","accountId":7,"email":"[email protected]","siteId":1,"state":"active","wpUsername":"[email protected]","name":"[email protected]","siteName":"my-presssable-net","roles":["clone_site","update_site_custom_name"]},"errors":null}},{"title":"Get Site Collaborator","description":"Get site collaborator information.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/collaborators/{id}' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzv'","response":{"message":"Success","data":{"id":1303,"created":"2022-02-18T16:25:46.000Z","updated":"2022-02-18T16:25:47.000Z","accountId":7,"email":"[email protected]","siteId":1,"state":"active","wpUsername":"[email protected]","name":"[email protected]","siteName":"my-presssable-net"},"errors":null}},{"title":"Delete Collaborator","description":"Delete a collaborator with the specified id.","request":"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}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Set Collaborator WP-Admin Password","description":"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.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/collaborators/{id}/wp-password-reset' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"message":"Success","data":"!WGhilzTwgAItI!q_GcyhF_o","errors":null}},{"title":"Domain List","description":"Get a list of domains for a given site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/domains' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"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}},{"title":"Add Domain","description":"Add a new domain to a site.","request":"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\"}'","response":{"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}},{"title":"Get Domain","description":"Get domain information.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/domains/{id}' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"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}},{"title":"Delete Domain","description":"Delete a domain from a site.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/domains/{id}' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"message":"Success","data":null,"errors":null}},{"title":"Set Primary Domain","description":"Set a domain as the primary domain. All other ARecord domains attached to your site will redirect to the primary domain.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/domains/{id}/primary' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"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}},{"title":"Get SFTP User List","description":"Get a list of FTP users for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/ftp' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"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":"[email protected]"},{"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":"[email protected]"},{"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":"[email protected]"},{"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":"[email protected]"}],"errors":null}},{"title":"Get SFTP User","description":"Get SFTP user by Id for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/ftp/{username}' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"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":"[email protected]"},"errors":null}},{"title":"Reset SFTP User Password","description":"Reset an FTP user password for the specified user and site.","request":"curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/ftp/password/{username}' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf'","response":{"message":"Success","data":"076b2818de6e39","errors":null}},{"title":"Jetpack License Information","description":"Get the Jetpack license information for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/jetpack' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"message":"Success","data":{"id":948,"siteId":1,"licenseKey":"premium_5bc9f55f12","issuedAt":1643659537,"revokedAt":null},"errors":null}},{"title":"Set Jetpack License","description":"When setting the Jetpack license on your site, the license will be set in the WP Options table for your site.","request":"curl --location --request POST 'https://my.pressable.com/v1/sites/{site_id}/jetpack' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"message":"Success","data":null,"errors":null}},{"title":"Statistics","description":"Get a list of statistics for a site. Data is updated once daily.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/statistics' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"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}},{"title":"Add Tags","description":"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.","request":"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\" ]}'","response":"{ \"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}"},{"title":"Remove Tags","description":"Remove tags from your site.","request":"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 ]}'","response":{"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}},{"title":"Note List","description":"Get the notes attached to the requested site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/notes' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf' --data '{ \"per_page\": 1, \"page\": 2}'","response":{"message":"Success","data":[{"id":418,"author":"[email protected]","editor":"[email protected]","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}},{"title":"Add Note","description":"Add notes to your site.","request":"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.\"}'","response":{"message":"Success","data":{"id":8,"author":"[email protected]","editor":"[email protected]","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}},{"title":"Get Note","description":"Get specified note for site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/notes/{id}' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf'","response":{"message":"Success","data":{"id":8,"author":"[email protected]","editor":"[email protected]","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}},{"title":"Update Note","description":"Update note for your site.","request":"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.\"}'","response":{"message":"Success","data":{"id":8,"author":"[email protected]","editor":"[email protected]","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}},{"title":"Delete Note","description":"Delete a note from your site.","request":"curl --location --request DELETE 'https://my.pressable.com/v1/sites/{site_id}/notes/{id}' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvzf'","response":{"message":"Success","data":null,"errors":null}},{"title":"Reset WP-Admin Password","description":"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.","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/wordpress/password-reset' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz'","response":{"message":"Success","data":"%Y6hDU%-Yu5okh5AvGN","errors":null}},{"title":"Get phpMyAdmin URL for Site","description":"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.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{site_id}/wordpress/phpmyadmin' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz'","response":{"message":"Success","data":"https://pressable.com/_pma_login?timestamp=1646159015\u0026nonce=202733835103\u0026token=c47c6b938","errors":null}},{"title":"Update WordPress Version for Site","description":"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).","request":"curl --location --request PUT 'https://my.pressable.com/v1/sites/{site_id}/wordpress/version' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImz' --data-raw '{ \"version\": \"latest\" }'","response":{"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}},{"title":"One Press Login","description":"Creates a one time url to sign-in to one of your WordPress sites as the user specified by the given email.","response":{"message":"Success","data":{"url":"https://mydomain.com/wp-login.php?mpcp_token=MS00Mzg1OTNlOTYzMjNkMWY3NTEjk4NjYtODU1YWJlMzNmNjEwNI"},"errors":null},"request":"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\": \"[email protected]\", \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36\"}'"},{"title":"PHP Error Logs","description":"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.","request":"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\"}'","response":{"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="}},{"title":"Web Server Logs","description":"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.","request":"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\" }'","response":{"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\u0026request_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\u0026request_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="}},{"title":"Activity Logs","description":"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.","request":"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\": \"[email protected]\" } ] }'","response":{"message":"Success","data":[{"id":4644222,"timestamp":"2023-09-28T11:02:55.141Z","accountEmail":"[email protected]","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":"[email protected]","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":"[email protected]","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":"[email protected]","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}},{"title":"Site Activity Log Actions","description":"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.","request":"curl --location --request GET 'https://my.pressable.com/v1/activity/site-actions' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGmhxdImz'","response":{"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}},{"title":"Disconnect SSH","description":"Terminate all SSH connections for a site.","request":"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'","response":{"message":"Success","data":null,"errors":null}},{"title":"Latest Performance Report","description":"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 .","request":"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'","response":{"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}},{"title":"Site Usage Report","description":"Get the usage details for a given site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/reports/usage' --header 'Authorization: Bearer coCy_QWq332qxjHvoU-AwiGWDEGm8ThxdImzvz' --header 'Content-Type: application/json'","response":{"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}}]},{"title":"Themes","description":"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.","actions":[{"title":"Theme List","description":"Get a list of themes for the specified site.","request":"curl --location --request GET 'https://my.pressable.com/v1/sites/{id}/themes' --header 'Authorization: Bearer zftCxjDbICWZE2_ToF8eCIXo3sHgcKSzT8BKh' --header 'Content-Type: application/json'","response":{"message":"Success","data":[{"name":"astra","title":"Astra","description":"Astra is fast, fully customizable \u0026 beautiful WordPress theme suitablenfor blog, personal portfolio, business website and WooCommerce storefront.nIt is very lightweight (less than 50KB on frontend) and offers unparallelednspeed. Built with SEO in mind, Astra comes with Schema.org code integratednand is Native AMP ready so search engines will love your site. It offersnspecial features and templates so it works perfectly with all page buildersnlike Elementor, Beaver Builder, Visual Composer, SiteOrigin, Divi, etc.nSome of the other features: # WooCommerce Ready # Responsive # RTL \u0026nTranslation Ready # Extendible with premium addons # Regularly updated #nDesigned, Developed, Maintained \u0026 Supported by Brainstorm Force.nLooking for a perfect base theme? Look no further. Astra is fast, fullyncustomizable and WooCommerce ready theme that you can use for building anynkind 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 forncreating beautiful fast loading and accessible websites, easier than ever.nIt features an easy to use drag and drop header and footer builder to buildnany type of header in minutes. It features a full library of gorgeousnstarter templates that are easy to modify with our intelligent global fontnand color controls. With extensive integration with the most popular 3rdnparty plugins, you can quickly build impressive ecommerce websites, coursenwebsites, business websites, and more.","status":"active","update":"available","version":"1.1.36","update_version":"1.1.39"}],"errors":null}},{"title":"Install and Activate Themes","description":"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.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Update Themes","description":"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.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Activate Themes","description":"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.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Delete Themes","description":"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.","request":"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\" } ]}'","response":{"message":"Success","data":null,"errors":null}}]},{"title":"WordPress","description":"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.","actions":[{"title":"WordPress User List","description":"This endpoint retrieves a list of WordPress users from your site.","request":"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}'","response":{"message":"Success","data":{"users":[{"id":1,"user_login":"john.doe","display_name":"john.doe","user_email":"[email protected]","roles":"administrator"},{"id":8,"user_login":"jane.doe","display_name":"jane.doe","user_email":"[email protected]","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}},{"title":"Create WordPress User","description":"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.","request":"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\": \"[email protected]\"}'","response":{"message":"Success","data":{"id":"10","email":"[email protected]","password":"1bb31b9bfee1e41644c8eec17c2d9bae"},"errors":null}},{"title":"Update WordPress User Password","description":"This endpoint allows for the modification of a WordPress user's password directly on your site.","request":"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\"}'","response":{"message":"Success","data":"my_new_password","errors":null}},{"title":"WP-CLI Commands","description":"This endpoint allows you to run WP-CLI commands via the API. WP-CLI is the command-line interface for WordPress.","request":"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\" ]}'","response":{"message":"Success","data":null,"errors":null}},{"title":"Bash Commands","description":"This endpoint allows you to run Bash commands via the API.","request":"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\" ]}'","response":{"message":"Success","data":null,"errors":null}}]},{"title":"Webhooks","description":"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.","actions":[{"title":"Site Created","description":"Sent when a site is created in your account.","response":{"event":"site_created","site":{"id":1,"state":"live"},"wp_admin":{"username":"johndoe","email":"[email protected]"}}},{"title":"Site Deleted","description":"Sent when a site is deleted in your account.","response":{"event":"site_deleted","site":{"id":1}}},{"title":"Site Converted","description":"Sent when a site is converted from staging to live or vice-versa","response":{"event":"site_converted","site":{"id":1,"site_converted_to":"staging"}}},{"title":"Site Enabled","description":"Sent when a site is enabled","response":{"event":"site_enabled","site":{"id":1,"state":"live"}}},{"title":"Site Disabled","description":"Sent when a site is disabled","response":{"event":"site_disabled","site":{"id":1,"state":"disabled"}}},{"title":"Site Hacked","description":"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.","response":{"event":"site_hacked","site":{"id":1,"state":"disabled","status":"hacked"}}},{"title":"Site Restore Success","description":"Sent when a site has been restored successfully","response":{"event":"site_restored","site":{"id":1},"restore":{"restored_by":"Tom Doe [[email protected]]","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}}},{"title":"Site Restore Failed","description":"Sent when a site restore has failed","response":{"event":"site_restore_failed","site":{"id":1},"restore":{"restored_by":"Tom Doe [[email protected]]","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"}}},{"title":"Site Sync Success","description":"Sent when a site has been synced successfully","response":"{ \"event\": \"sync_success\", \"from_site_id\": 3, \"to_site_id\": 1, \"restore_sync_request\": { \"message\": \"Sync completed successfully\", \"status\": \"completed\", \"requested_by\": \"Tom Doe [[email protected]]\", }}"},{"title":"Site Sync Failed","description":"Sent when a site sync has failed","response":"{ \"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 [[email protected]]\", }}"},{"title":"Site SSH Command","description":"Sent when a site has run an SSH command","response":{"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"}}},{"title":"Site Maintenance Mode","description":"Sent when a site has been toggled into or out of maintenance mode","response":{"event":"maintenance_mode","site_id":1,"maintenance_mode":"enabled | disabled"}},{"title":"Site Plugin Installed Successfully","description":"Sent when a Plugin is installed successfully for a site. Version is returned as `latest` if no version was specified.","response":{"event":"plugin_installed","site":{"id":1},"plugin":{"path":"wpforms-lite","version":"1.8.0.2"}}},{"title":"Site Plugin Install Failed","description":"Sent when a Plugin fails to install for a site. Version is returned as `latest` if no version was specified.","response":{"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"}}},{"title":"Site Plugin Updated Successfully","description":"Sent when a Plugin is successfully updated for a site. Version is returned as `latest` if no version was specified.","response":{"event":"plugin_updated","site":{"id":1},"plugin":{"path":"wpforms-lite","version":"latest"}}},{"title":"Site Plugin Update Failed","description":"Sent when a Plugin fails to update for a site. Version is returned as `latest` if no version was specified.","response":{"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)"}}},{"title":"Site Plugin Deactivated Successfully","description":"Sent when a Plugin is successfully deactivated for a site.","response":{"event":"plugin_deactivated","site":{"id":1},"plugin":{"path":"wpforms-lite"}}},{"title":"Site Plugin Deactivation Failed","description":"Sent when a Plugin fails to deactivate for a site.","response":{"event":"plugin_deactivation_failed","site":{"id":1},"plugin":{"path":"wpforms-lite"},"error":{"message":"Could not deactivate plugin - wpforms-lite - Error: No plugins deactivated"}}},{"title":"Site Plugin Activated Successfully","description":"Sent when a Plugin is successfully activated for a site.","response":{"event":"plugin_activated","site":{"id":1},"plugin":{"path":"wpforms-lite"}}},{"title":"Site Plugin Activation Failed","description":"Sent when a Plugin fails to activate for a site.","response":{"event":"plugin_activation_failed","site":{"id":1},"plugin":{"path":"wpforms-lite"},"error":{"message":"Could not activate plugin - wpforms-lite - Error: No plugins activated"}}},{"title":"Site Plugin Deleted Successfully","description":"Sent when a Plugin is successfully deleted for a site.","response":{"event":"plugin_deleted","site":{"id":1},"plugin":{"path":"wpforms-lite"}}},{"title":"Site Plugin Delete Failed","description":"Sent when a Plugin fails to delete for a site.","response":{"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"}}},{"title":"Site Theme Installed Successfully","description":"Sent when a Theme is installed successfully for a site. Version is returned as `latest` if no version was specified.","response":{"event":"theme_installed","site":{"id":1},"theme":{"path":"astra","version":"3.0.1"}}},{"title":"Site Theme Install Failed","description":"Sent when a Theme fails to install for a site. Version is returned as `latest` if no version was specified.","response":{"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"}}},{"title":"Site Theme Updated Successfully","description":"Sent when a Theme is successfully updated for a site. Version is returned as `latest` if no version was specified.","response":{"event":"theme_updated","site":{"id":1},"theme":{"path":"astra","version":"latest"}}},{"title":"Site Theme Update Failed","description":"Sent when a Theme fails to update for a site. Version is returned as `latest` if no version was specified.","response":{"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)"}}},{"title":"Site Theme Activated Successfully","description":"Sent when a Theme is successfully activated for a site.","response":{"event":"theme_activated","site":{"id":1},"theme":{"path":"astra"}}},{"title":"Site Theme Activation Failed","description":"Sent when a Theme fails to activate for a site.","response":{"event":"theme_activation_failed","site":{"id":1},"theme":{"path":"astra"},"error":{"message":"Could not activate theme - astra - Error: No themes activated"}}},{"title":"Site Theme Deleted Successfully","description":"Sent when a Theme is successfully deleted for a site.","response":{"event":"theme_deleted","site":{"id":1},"theme":{"path":"astra"}}},{"title":"Site Theme Delete Failed","description":"Sent when a Theme fails to delete for a site.","response":{"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"}}},{"title":"Git Deploy Completed","description":"Sent when Git deploy completes successfully","response":{"event":"git_deploy_completed","site":{"id":1},"git":{"before":"9dd0f047","after":"13407c6d","name":"john","email":"[email protected]","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"}}},{"title":"Git Deploy Failed","description":"Sent when Git deploy fails","response":{"event":"git_deploy_failed","site":{"id":1},"git":{"error":{"message":"Could not execute a Git deploy for my-presssable-net [1] - invalid auth token"}}}},{"title":"PHP Version Changed","description":"Sent when a site's PHP version is changed","response":{"event":"php_version_changed","site":{"id":1,"state":"live","php_version":8.0}}},{"title":"WP Environment Type","description":"Sent when a site's WP Environment Type is changed","response":{"event":"wp_environment_type_changed","site":{"id":1,"state":"live","wp_environment_type":"staging"}}},{"title":"WordPress Version Changed","description":"Sent when a site's WordPress Version is changed","response":{"event":"wordpress_version_changed","site":{"id":1,"state":"live","wp_version":"beta","wp_version_text":"Latest Release (Beta)"}}},{"title":"WordPress Admin Password Reset","description":"Sent when a WordPress Admin User Password has been reset","response":{"event":"wordpress_admin_password_reset","site":{"id":1},"user":{"email":"[email protected]"}}},{"title":"Light Weight 404 Setting Changed","description":"Sent when a site's Light Weight 404 setting is enabled, or disabled","response":{"event":"light_weight_404_changed","site":{"id":1,"state":"live","light_weight_404_changed":"enabled"}}},{"title":"Collaborator Added","description":"Sent when a collaborator is added to a site","response":{"event":"collaborator_added","site":{"id":1},"collaborator":{"id":1,"email":"[email protected]"}}},{"title":"Collaborator Deleted","description":"Sent when a collaborator is deleted from a site","response":{"event":"collaborator_deleted","site":{"id":1},"collaborator":{"id":1,"email":"[email protected]"}}},{"title":"SFTP User Password Reset","description":"Sent when an SFTP User password has been reset","response":{"event":"sftp_user_password_reset","site":{"id":1},"sftp":{"username":"john"}}},{"title":"On-Demand Backup Created","description":"Sent when an On-Demand backup is created for a site","response":{"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 [[email protected]]"},"site":{"id":1223013}}},{"title":"On-Demand Backup Deleted","description":"Sent when an On-Demand backup is deleted from a site","response":{"event":"ondemand_backup_deleted","backup":{"id":"5056740232","status":"deleted","type":"fs","deleted_by":"John Doe [[email protected]]","deleted_at":"2023-05-01T16:31:03.000Z","deleted_at_timestamp":1682958663},"site":{"id":1}}},{"title":"Enabled Edge Cache","description":"Sent when Edge Cache is enabled for a site","response":{"event":"enabled_edge_cache","site":{"id":5},"user":{"email":"[email protected]"}}},{"title":"Disabled Edge Cache","description":"Sent when Edge Cache is disabled for a site","response":{"event":"disabled_edge_cache","site":{"id":5},"user":{"email":"[email protected]"}}},{"title":"Purged Edge Cache","description":"Sent when Edge Cache is purged for a site","response":{"event":"purged_edge_cache","site":{"id":5},"user":{"email":"[email protected]"}}},{"title":"Edge Cache Defensive Mode","description":"Sent when Edge Cache Defensive Mode action is used to activate or deactivate defensive mode for a site","response":{"event":"edge_cache_defensive_mode","site":{"id":5},"edge_cache":{"enabled":true,"defensive_mode":true,"defensive_mode_until":1720882555}}},{"title":"Primary Domain Set","description":"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.","response":{"event":"primary_domain_set","site":{"id":1},"record":{"url":"www.domain.com","id":12}}},{"title":"Domain Added","description":"Sent when a new domain has been added","response":{"event":"domain_added","site":{"id":1},"record":{"url":"www.domain.com","id":12}}},{"title":"Domain Removed","description":"Sent when a domain has been removed","response":{"event":"domain_removed","site":{"id":1},"record":{"url":"www.domain.com","id":12}}},{"title":"Must-Use Plugin Install Success","description":"Sent when mu-plugin install completes successfully","response":{"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\u0026dl=0","message":"Added mu-plugin pressable-maintenance-mode-plugin.php [ https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l\u0026dl=0 ]"}}},{"title":"Must-Use Plugin Install Failed","description":"Sent when mu-plugin install failed","response":{"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\u0026dl=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\u0026dl=0 ] - directory not found"}}},{"title":"Must-Use Plugin Update Success","description":"Sent when mu-plugin update completes successfully","response":{"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\u0026dl=0","message":"Updated mu-plugin pressable-maintenance-mode-plugin.php [ https://www.dropbox.com/scl/fi/ruyi6sf4lcyjlhjwykp22/pressable-maintenance-mode-plugin.php?rlkey=e9wqk610ipjc5qomoy8h9tk7l\u0026dl=0 ]"}}},{"title":"Must-Use Plugin Update Failed","description":"Sent when mu-plugin update failed","response":{"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\u0026dl=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\u0026dl=0 ] - directory not found"}}},{"title":"Must-Use Plugin Deleted","description":"Sent when mu-plugin is deleted","response":{"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 ]"}}},{"title":"Site Performance Report Created","description":"Sent when a performance report is created for a site","response":"{ \"event\": \"performance_report_created\", \"site\": { \"id\": 1223013 }, \"performance_report\": { \"id\": 50567, }}"}]},{"title":"Errors","description":"We use conventional HTTP response codes to indicate the success, or failure, of an API request.","actions":[]},{"title":"Job Queues","description":"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.","actions":[]}]