{"openapi":"3.0.3","info":{"title":"Pressable API Documentation (v1)","version":"1.0.0","description":"The Pressable API is a tool for our customers to create personalized experiences and automate routine tasks. It accepts form-encoded requests and responds with information in a format called JSON. Although this OpenAPI documentation is a part of our resources, it's specially crafted for customers to use machine learning programs to generate documentation, tools or applications. If you're looking for more user friendly instructions and information, we recommend checking out our [main API documentation page](https://my.pressable.com/documentation/api/v1).","termsOfService":"https://pressable.com/legal/","contact":{"email":"[email protected]"}},"externalDocs":{"description":"Find out more about The Pressable REST based API","url":"https://my.pressable.com/documentation/api/v1"},"servers":[{"url":"https://my.pressable.com/v1"}],"paths":{"/auth/token":{"post":{"tags":["auth"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"grant_type":{"type":"string"},"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string","example":"EXAMPLE_ACCESS_TOKEN"},"token_type":{"type":"string","example":"Bearer"},"expires_in":{"type":"integer","example":3599},"scope":{"type":"string","example":"authorized"},"created_at":{"type":"integer","example":1686949418},"id":{"type":"integer","example":1},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"[email protected]"},"gravatar":{"type":"string","example":"https://www.gravatar.com/avatar/3b0e9a78b5621fce924f7ce107180970371cf75f565dfaa5e4babe2e4866422a?d=mp"},"scopes":{"type":"array","items":{"type":"string"},"example":["authorized","owner"]}}}}}}}}},"/auth/revoke":{"post":{"tags":["auth"],"summary":"Revoke Access Token","description":"Revoke an access token to stop the access token from being able to make API requests.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/account":{"get":{"tags":["account"],"summary":"Account Details","description":"Get your account profile information.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":[]}}}}}}}}},"put":{"tags":["account"],"summary":"Set Account Datacenter","description":"Set a default Datacenter for all new sites created in your account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"datacenter_code":{"type":"string"}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/account/logs/activity":{"post":{"tags":["account"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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":{"type":"object","example":{"currentPage":1,"nextPage":2,"lastPage":7,"perPage":5,"totalItems":35}}}}}}}}}},"/activity/account-actions":{"get":{"tags":["activity"],"summary":"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.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"name":"account.collaborator","description":"Account Collaborator"},{"name":"banned","description":"Banned"},{"name":"created","description":"Created"},{"name":"dns","description":"DNS Records Updated"}]}}}}}}}}},"/account/addons":{"get":{"tags":["account"],"summary":"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.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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}]}}}}}}}},"put":{"tags":["account"],"summary":"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:","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addon_id":{"type":"integer"},"quantity":{"type":"integer"}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"name":"1 Site","quantity":5},{"name":"10K Site Visits","quantity":5},{"name":"10GB Site Storage","quantity":5}]}}}}}}}}},"/account/addons/attached":{"get":{"tags":["account"],"summary":"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.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"name":"1 Site","quantity":1},{"name":"10K Site Visits","quantity":1},{"name":"10GB Site Storage","quantity":1}]}}}}}}}}},"/collaborators/{id}":{"get":{"tags":["collaborators"],"summary":"Get Collaborator","description":"Get collaborator information for the specified collaborator.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"]}}}}}}}}}},"/collaborators/update-account-level-access":{"put":{"tags":["collaborators"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"add_to_all_new":{"type":"boolean"},"create_site":{"type":"boolean"},"manage_tags":{"type":"boolean"},"account_notifications":{"type":"boolean"},"site_management_notifications":{"type":"boolean"},"site_operation_notifications":{"type":"boolean"},"roles":{"type":"array","items":{"type":"string"}}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"email":"[email protected]","add_to_all_new":true,"create_site":true}}}}}}}}}},"/collaborators/batch_create":{"post":{"tags":["collaborators"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"siteIds":{"type":"array","items":{"type":"integer"}},"roles":{"type":"array","items":{"type":"string"}}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Collaborator creation scheduled for 2 sites"}}}}}}}}},"/collaborators/batch_destroy":{"post":{"tags":["collaborators"],"summary":"Bulk Delete","description":"Removes a collaborator with the provided email address from a list of sites.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"delete_wp_user":{"type":"boolean"},"siteIds":{"type":"array","items":{"type":"integer"}}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Collaborator removal scheduled for 3 sites"}}}}}}}}},"/collaborators/{collaborator_id}/site":{"get":{"tags":["collaborators"],"summary":"Get Site","description":"Get a specific site that belongs to the specified collaborator.","parameters":[{"in":"path","name":"collaborator_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"sftpDomain":"sftp.pressable.com","phpVersion":"8.2","tags":[]}}}}}}}}}},"/collaborators/{email_address}/sites":{"get":{"tags":["collaborators"],"summary":"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.","parameters":[{"in":"path","name":"email_address","required":true,"schema":{"type":"string"}},{"in":"query","name":"tag_name","schema":{"type":"string"}},{"in":"query","name":"per_page","schema":{"type":"integer"}},{"in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":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,"sandbox":false,"sftpDomain":"sftp.pressable.com","phpVersion":"8.2","tags":[]}]}},"page":{"type":"object","example":{"currentPage":1,"nextPage":2,"lastPage":65,"perPage":20,"totalItems":1297}}}}}}}}}},"/collaborators/{email_address}/sites/{site_id}":{"get":{"tags":["collaborators"],"summary":"Get Site using Email Address","description":"Get a site attached to a collaborator.","parameters":[{"in":"path","name":"email_address","required":true,"schema":{"type":"string"}},{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"sftpDomain":"sftp.pressable.com","phpVersion":"8.2","tags":[]}]}}}}}}}}}},"/collaborators/{email_address}/sites/{site_id}/favorite":{"post":{"tags":["collaborators"],"summary":"Add Site as Favorite","description":"Add a site to collaborator site favorites. Favorite sites show up first in collaborator site listings.","parameters":[{"in":"path","name":"email_address","required":true,"schema":{"type":"string"}},{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"sftpDomain":"sftp.pressable.com","phpVersion":"8.2","tags":[]}]}}}}}}}}},"delete":{"tags":["collaborators"],"summary":"Remove Site as Favorite","description":"Remove a site from a collaborators list of site favorites.","parameters":[{"in":"path","name":"email_address","required":true,"schema":{"type":"string"}},{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"sftpDomain":"sftp.pressable.com","phpVersion":"8.2","tags":[]}]}}}}}}}}}},"/zones":{"get":{"tags":["zones"],"summary":"Get Zones","description":"Get the zones attached to your account.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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"}]}}}}}}}}},"/zones/{zone_id}/records":{"get":{"tags":["zones"],"summary":"Get Zone Records","description":"Returns all the DNS records attached to a zone.","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":true,"type":"TXT","name":"press","value":"atomic-domain-9bafa2a899c4ee84dbae5778","priority":null,"weight":null,"port":null,"ttl":3600,"siteId":null,"created":"2022-02-18T16:49:40.000Z"},{"id":40,"zoneId":6,"primary":false,"type":"CNAME","name":"openhosting1._domainkey.press","value":"openhosting1._domainkey.wpcloud.com.","priority":null,"weight":null,"port":null,"ttl":3600,"siteId":null,"created":"2022-02-18T16:49:40.000Z"},{"id":40,"zoneId":6,"primary":false,"type":"CNAME","name":"openhosting2._domainkey.press","value":"openhosting2._domainkey.wpcloud.com.","priority":null,"weight":null,"port":null,"ttl":3600,"siteId":null,"created":"2022-02-18T16:49:40.000Z"}]}}}}}}}}},"post":{"tags":["zones"],"summary":"Create Zone Record","description":"","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"ttl":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}]}}}}}}}}}},"/zones/{zone_id}/records/{id}":{"delete":{"tags":["zones"],"summary":"Delete Record","description":"Delete a DNS record from a zone.","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}]}}}}}}}}}},"/zones/{zone_id}/providers":{"post":{"tags":["zones"],"summary":"Generate Email Provider Records","description":"Generate all the email records for popular providers. The records will be attached to the requested zone.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/zones/{zone_id}/records/{id}/ssl":{"get":{"tags":["zones"],"summary":"SSL Certificate Details","description":"Returns the SSL certificate details for an A Record.","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"No information found"},"errors":{"type":"array","items":{"type":"string"},"example":["No information found"]}}}}}}}},"put":{"tags":["zones"],"summary":"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.","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"There was a problem processing your request."},"errors":{"type":"array","items":{"type":"string"},"example":["SSL can only be retried on A records"]}}}}}}}}},"/sites/{id}/edge-cache":{"get":{"tags":["sites"],"summary":"Edge Cache Status","description":"Get the current status of the edge cache for your site.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"active":true,"defensive_mode":{"active":true,"active_until":1724951720}}}}}}}}}},"put":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}},"delete":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/edge-cache/defensive-mode":{"put":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"duration":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"sftpDomain":"sftp.pressable.com","phpVersion":"8.0","wordpressVersion":"Current Stable Release (6.2)","tags":[{"id":354,"name":"Clannad"}],"wpEnvironmentType":"development","lightWeight404":false}}}}}}}}}},"/mu-plugins":{"get":{"tags":["mu-plugins"],"summary":"Get Must-Use Plugin List","description":"Get a list of your mu-plugins.","parameters":[{"in":"query","name":"page","schema":{"type":"integer"}},{"in":"query","name":"per_page","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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":{"type":"object","example":{"currentPage":1,"nextPage":null,"lastPage":1,"perPage":20,"totalItems":2}}}}}}}}},"post":{"tags":["mu-plugins"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string"},"existing_sites":{"type":"boolean"},"future_sites":{"type":"boolean"}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}}},"/mu-plugins/{id}":{"get":{"tags":["mu-plugins"],"summary":"Get Must-Use Plugin","description":"Get details about your mu-plugin.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}},"put":{"tags":["mu-plugins"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}},"delete":{"tags":["mu-plugins"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/ondemand-backups":{"get":{"tags":["sites"],"summary":"On-Demand Backup List","description":"Get a list of on-demand backups for the specified site.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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}]}}}}}}}},"post":{"tags":["sites"],"summary":"Create On-Demand Backup","description":"Create an on-demand backup for the specified site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"backup_type":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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}}}}}}}}}},"/sites/{site_id}/ondemand-backups/{id}":{"get":{"tags":["sites"],"summary":"Get On-Demand Backup","description":"Get the details for a specific on-demand backup attached to the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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}}}}}}}}},"delete":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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}}}}}}}}}},"/sites/{site_id}/ondemand-backups/{id}/download":{"get":{"tags":["sites"],"summary":"Download On-Demand Backup","description":"Download the specified on-demand backup attached to the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"string"},"errors":{"type":"array","items":{"type":"string"},"example":["string"]}}}}}}}}},"/sites/{id}/plugins":{"get":{"tags":["sites"],"summary":"Plugin List","description":"Get a list of plugins for the specified site.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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}]}}}}}}}},"post":{"tags":["sites"],"summary":"Install and Activate Plugins","description":"To enhance your WordPress site, install and activate plugins to add new features, functionality, and customization options effortlessly.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"plugins":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"version":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}},"put":{"tags":["sites"],"summary":"Update Plugins","description":"Regularly updating plugins is crucial for WordPress sites to ensure optimal performance, security, and compatibility with the latest features and enhancements.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"plugins":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"version":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}},"delete":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"plugins":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/plugins/deactivate":{"put":{"tags":["sites"],"summary":"Deactivate Plugins","description":"Deactivating plugins on WordPress sites allows for troubleshooting, prevents conflicts, and temporarily disables specific functionalities without removing the plugin entirely.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"plugins":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/plugins/activate":{"put":{"tags":["sites"],"summary":"Activate Plugins","description":"Activating previously deactivated plugins restores desired functionalities, expands features, and re-enables customizations.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"plugins":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/security-alerts/plugins":{"get":{"tags":["sites"],"summary":"Plugin Alerts","description":"Get a list of plugins reporting security issues","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"active":[{"id":1126,"site_id":4,"name":"redirection","version":"1.1","status":"active","active":true,"update_available":false,"update_version":null,"security_risk":true,"security_alerts":[{"title":"Redirection \u003c= 3.6.2 - Cross-Site Request Forgery (CSRF)","description":"The Redirection WordPress plugin was affected by a Cross-Site Request Forgery (CSRF) security vulnerability.","severity":null,"fixed_in":"3.6.3","reference_urls":["https://www.ripstech.com/php-security-calendar-2018/","https://plugins.trac.wordpress.org/changeset/1974375/redirection"]},{"title":"Redirection \u003c 2.8 - Authenticated Local File Inclusion","description":"The Redirection WordPress plugin was affected by an Authenticated Local File Inclusion security vulnerability.","severity":null,"fixed_in":"2.8","reference_urls":["https://advisories.dxw.com/advisories/ace-file-inclusion-redirection/","https://seclists.org/fulldisclosure/2018/Jun/29"]},{"title":"Redirection 2.3.3 - view/admin/item.php URL Handling Reflected XSS","description":"The Redirection WordPress plugin was affected by a view/admin/item.php URL Handling Reflected XSS security vulnerability.","severity":null,"fixed_in":"2.3.4","reference_urls":[]},{"title":"Redirection - view/admin/log_item.php Non-existent Posts Referer HTTP Header XSS","description":"The Redirection WordPress plugin was affected by a view/admin/log_item.php Non-existent Posts Referer HTTP Header XSS security vulnerability.","severity":null,"fixed_in":"2.2.10","reference_urls":[]},{"title":"Redirection - wp-admin/tools.php id Parameter XSS","description":"The Redirection WordPress plugin was affected by a wp-admin/tools.php id Parameter XSS security vulnerability.","severity":"medium","fixed_in":"2.2.9","reference_urls":[]},{"title":"Redirection \u003c 2.2.12 - XSS","description":"The Redirection WordPress plugin was affected by a XSS security vulnerability.","severity":"medium","fixed_in":"2.2.12","reference_urls":[]}]}],"must-use":[{"id":717,"site_id":4,"name":"wordfence","version":"1.0","status":"must-use","active":false,"update_available":true,"update_version":"6.9.8","security_risk":true,"security_alerts":[{"title":"Wordfence \u003c 7.6.1 - Admin+ Stored Cross-Site Scripting","description":"The plugin does not sanitise and escape a settings, which could allow high privilege users such as admin to perform Stored Cross-Site Scripting attacks even when the unfiltered_html capability is disallowed (for example in multisite setup)","severity":"low","fixed_in":"7.6.1","reference_urls":[]},{"title":"Wordfence \u003c 7.1.14 - Username Enumeration Prevention Bypass","description":"The plugin protection against user enumeration (ie ?author=id) could be bypassed by using an array as author parameter","severity":"medium","fixed_in":"7.1.14","reference_urls":["http://www.waraxe.us/advisory-109.html","https://packetstormsecurity.com/files/149845/"]},{"title":"Wordfence \u003c= 5.1.4 - Cross-Site Scripting (XSS)","description":"An attacker can inject arbitrary script via the vulnerable query string parameter val of the whois.php file.","severity":"medium","fixed_in":"5.1.5","reference_urls":[]},{"title":"Wordfence 5.2.2 - XSS in Referer Header","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by a XSS in Referer Header security vulnerability.","severity":null,"fixed_in":"5.2.3","reference_urls":["https://vexatioustendencies.com/wordpress-plugin-vulnerability-dump-part-2/"]},{"title":"Wordfence \u003c= 5.2.4 - Multiple Vulnerabilities (XSS \u0026 Bypasses)","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by a Multiple Vulnerabilities (XSS \u0026 Bypasses) security vulnerability.","severity":null,"fixed_in":"5.2.5","reference_urls":["https://secupress.me/blog/wordfence-5-2-5-security-update/","https://www.securityfocus.com/bid/70915/"]},{"title":"Wordfence 5.2.3 - Multiple Vulnerabilities","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by a Multiple Vulnerabilities security vulnerability.","severity":null,"fixed_in":"5.2.4","reference_urls":["https://vexatioustendencies.com/wordfence-v5-2-3-2-stored-xss-insufficient-logging-throttle-bypass-exploit-detection-bypass/"]},{"title":"Wordfence 5.2.3 - Banned IP Functionality Bypass","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by a Banned IP Functionality Bypass security vulnerability.","severity":null,"fixed_in":"5.2.4","reference_urls":["https://packetstormsecurity.com/files/128259/","https://seclists.org/fulldisclosure/2014/Sep/49","https://vexatioustendencies.com/wordfence-v5-2-3-2-stored-xss-insufficient-logging-throttle-bypass-exploit-detection-bypass/"]},{"title":"Wordfence 5.2.4 - IPTraf.php URI Request Stored XSS","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by an IPTraf.php URI Request Stored XSS security vulnerability.","severity":null,"fixed_in":"5.2.5","reference_urls":["https://packetstormsecurity.com/files/128259/"]},{"title":"Wordfence 5.2.4 - Unspecified Issue","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by an Unspecified Issue security vulnerability.","severity":null,"fixed_in":"5.2.5","reference_urls":[]},{"title":"Wordfence 3.8.1 - wp-admin/admin.php whois Parameter Stored XSS","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by a wp-admin/admin.php whois Parameter Stored XSS security vulnerability.","severity":null,"fixed_in":"3.8.3","reference_urls":["https://packetstormsecurity.com/files/122993/","https://www.securityfocus.com/bid/62053/"]},{"title":"Wordfence 3.3.5 - XSS \u0026 IAA","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by a XSS \u0026 IAA security vulnerability.","severity":null,"fixed_in":"3.3.7","reference_urls":["https://seclists.org/fulldisclosure/2012/Oct/139"]},{"title":"Wordfence 3.8.6 - lib/IPTraf.php User-Agent Header Stored XSS","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by a lib/IPTraf.php User-Agent Header Stored XSS security vulnerability.","severity":null,"fixed_in":"3.8.7","reference_urls":[]},{"title":"Wordfence 3.8.1 - Password Creation Restriction Bypass","description":"The Wordfence Security – Firewall \u0026 Malware Scan WordPress plugin was affected by a Password Creation Restriction Bypass security vulnerability.","severity":null,"fixed_in":"3.8.3","reference_urls":[]}]}]}}}}}}}}}},"/sites/{id}/security-alerts/themes":{"get":{"tags":["sites"],"summary":"Theme Alerts","description":"Get a list of themes reporting security issues","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"active":[{"id":62,"site_id":495,"name":"Divi","version":"4.15.1","status":"active","active":true,"update_available":false,"update_version":null,"security_risk":true,"security_alerts":[{"title":"Divi \u003c 4.25.2 - Contributor+ Stored XSS","description":"The theme is vulnerable to Stored Cross-Site Scripting due to insufficient input sanitization and output escaping. This makes it possible for authenticated attackers, with Author-level access and above, to inject arbitrary web scripts in pages that will execute whenever a user accesses an injected page.","severity":"medium","fixed_in":"4.25.2","reference_urls":["https://www.wordfence.com/threat-intel/vulnerabilities/id/6571a899-f217-434f-bbed-b1faf77a8d8b"]},{"title":"Elegant Themes Divi Theme, Extra Theme, Divi Page Builder \u003c= 4.25.0 - Authenticated (Contributor+) DOM-Based Stored Cross-Site Scripting","description":"The Elegant Themes Divi theme, Extra theme, and Divi Page Builder plugin for WordPress are vulnerable to DOM-Based Stored Cross-Site Scripting via the ‘title’ parameter in versions up to, and including, 4.25.0 due to insufficient input sanitization and output escaping. This makes it possible for authenticated attackers, with contributor-level permissions and above, to inject arbitrary web scripts in pages that will execute whenever a user accesses an injected page.","severity":"medium","fixed_in":"4.25.1","reference_urls":["https://www.wordfence.com/threat-intel/vulnerabilities/id/efac70f6-d959-41f7-bdef-d554f1c9133e"]},{"title":"Divi \u003c 4.23.2 - Authenticated (Contributor+) Stored Cross-Site Scripting via Shortcode","description":"The Divi theme for WordPress is vulnerable to Stored Cross-Site Scripting via the plugin's 'et_pb_text' shortcode in all versions up to, and including, 4.23.1 due to insufficient input sanitization and output escaping on user supplied custom field data. This makes it possible for authenticated attackers, with contributor-level access and above, to inject arbitrary web scripts in pages that will execute whenever a user accesses an injected page.","severity":"medium","fixed_in":"4.23.2","reference_urls":["https://www.wordfence.com/threat-intel/vulnerabilities/id/999475c5-5f17-47fa-a0d0-47cb5a8a0eb4"]},{"title":"Divi \u003c 4.20.3 - Contributor+ Stored XSS","description":"The theme does not validate and escape some parameters, which could allow users with the contributor role and above to perform Stored Cross-Site Scripting attacks","severity":"medium","fixed_in":"4.20.3","reference_urls":[]}]}]}}}}}}}}}},"/sites":{"get":{"tags":["sites"],"summary":"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.","parameters":[{"in":"query","name":"paginate","schema":{"type":"boolean"}},{"in":"query","name":"per_page","schema":{"type":"integer"}},{"in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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":null,"favorite":false,"fileSystemUsageBytes":10737418240,"databaseUsageBytes":2147483648,"maxFileSystemUsageBytes":null,"warningHeadroomFileSystemUsageBytes":null,"maxDatabaseUsageBytes":null,"warningHeadroomDatabaseUsageBytes":null,"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,"sandbox":false,"duplikit":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":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,"sandbox":false,"duplikit":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":null,"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,"sandbox":false,"duplikit":false,"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":{"type":"object","example":{"currentPage":1,"nextPage":2,"lastPage":66,"perPage":20,"totalItems":1309}}}}}}}}},"post":{"tags":["sites"],"summary":"Create Site","description":"Create a new site in your account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"php_version":{"type":"string"},"staging":{"type":"boolean"},"sandbox":{"type":"boolean"},"duplikit":{"type":"boolean"},"install":{"type":"string"},"multisite_support":{"type":"string"},"datacenter_code":{"type":"string"},"wp_admin_username":{"type":"string"},"wp_admin_email":{"type":"string"}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":false,"duplikit":false,"sftpDomain":"sftp.pressable.com","phpVersion":null,"wordpressVersion":"Current Stable Release (6.2)","tags":[],"wpEnvironmentType":"production","lightWeight404":false,"multisiteSupport":true}}}}}}}}}},"/sites/validate":{"post":{"tags":["sites"],"summary":"Validate Site Name","description":"Use this endpoint to check if a site name is valid before attempting to create a site.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"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":{"type":"object","example":{"valid":false}}}}}}}}}},"/sites/{id}":{"get":{"tags":["sites"],"summary":"Get Site","description":"Get site information and settings.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":false,"duplikit":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}}}}}}}}},"put":{"tags":["sites"],"summary":"Update Site","description":"Update the Display Name, PHP Version or WP Environment Type for a site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"php_version":{"type":"string"},"wp_environment_type":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":false,"duplikit":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}}}}}}}}},"delete":{"tags":["sites"],"summary":"Delete Site","description":"Delete a site with the specified id.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/search":{"post":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"per_page":{"type":"integer"},"page":{"type":"integer"}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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,"sandbox":false,"duplikit":false,"state":"deploying","wordpressVersion":"Current Stable Version (6.3)","wpEnvironmentType":"production","multisiteSupport":false}]},"page":{"type":"object","example":{"currentPage":1,"nextPage":null,"lastPage":1,"perPage":20,"totalItems":1}}}}}}}}}},"/sites/install-options":{"get":{"tags":["sites"],"summary":"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.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"string"},"example":["wordpress","woocommerce"]}}}}}}}}},"/sites/datacenters":{"get":{"tags":["sites"],"summary":"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.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"code":"BUR","name":"Los Angeles, CA, USA"},{"code":"DCA","name":"Washington, DC, USA"},{"code":"DFW","name":"Dallas, TX, USA"}]}}}}}}}}},"/sites/php-versions":{"get":{"tags":["sites"],"summary":"Valid PHP Versions","description":"Get valid PHP versions that are currently available for sites hosted within our platform.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"string"},"example":["8.2","8.3","8.4","8.5"]}}}}}}}}},"/sites/{id}/disable":{"put":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"duplikit":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}}}}}}}}}},"/sites/{id}/enable":{"put":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":false,"duplikit":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}}}}}}}}}},"/sites/{id}/convert":{"put":{"tags":["sites"],"summary":"Convert Site (Staging/Live)","description":"Staging/Sandbox to Live","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":false,"duplikit":false,"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}}}}}}}}}},"/sites/{id}/convert/duplikit":{"put":{"tags":["sites"],"summary":"Convert Site To DupliKit","description":"Convert To DupliKit","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":false,"duplikit":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}}}}}}}}}},"/sites/{id}/convert/sandbox":{"put":{"tags":["sites"],"summary":"Convert Site To Sandbox","description":"Staging to Sandbox","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":true,"duplikit":false,"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}}}}}}}}}},"/sites/{id}/convert/live":{"put":{"tags":["sites"],"summary":"Convert Site To Live","description":"Coverting to Live","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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":false,"sandbox":false,"duplikit":false,"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}}}}}}}}}},"/sites/{id}/convert/staging":{"put":{"tags":["sites"],"summary":"Convert Site To Staging","description":"Live to Staging","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":false,"duplikit":false,"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}}}}}}}}}},"/sites/{site_id}/object-cache":{"delete":{"tags":["sites"],"summary":"Flush Object Cache","description":"Flush the object cache for a site with the specified id.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/light_weight_404":{"put":{"tags":["sites"],"summary":"Toggle Light Weight 404","description":"Enable or Disable Light Weight 404 handling for a site with the specified id.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"lightWeight404Enabled":true}}}}}}}}}},"/sites/{id}/multisite-support":{"put":{"tags":["sites"],"summary":"Toggle Multisite Support","description":"Please note that you must be on a High Traffic Plan to use this feature.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"duplikit":false,"sftpDomain":"sftp.pressable.com","phpVersion":"8.2","wordpressVersion":"Current Stable Version (6.5)","tags":[],"wpEnvironmentType":"development","lightWeight404":false,"multisiteSupport":true}}}}}}}}}},"/sites/{id}/maintenance-mode":{"put":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/basic-authentication":{"put":{"tags":["sites"],"summary":"Basic Authentication","description":"The \"Basic Authentication\" feature allows you to easily restrict public access to your website. When installed, it activates the Pressable Basic Authentication plugin, which requires anyone visiting your site to enter a username and password before gaining access. This is especially useful for in-progress development sites where you want to keep content private. Removing the Basic Authentication plugin removes this login requirement, making your site fully open to the public. Be sure all content is production-ready before turning it off to ensure a professional experience for your audience.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/favorites":{"post":{"tags":["sites"],"summary":"Favorite Site","description":"Add a site to your site favorites, favorite sites show up first in site listings.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{site_id}/favorites":{"delete":{"tags":["sites"],"summary":"Unfavorite Site","description":"Remove a site as a favorite with the specified site id.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{site_id}/clone":{"post":{"tags":["sites"],"summary":"Create Site Clone","description":"Create a copy of the specified site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"staging":{"type":"boolean"},"sandbox":{"type":"boolean"},"duplikit":{"type":"boolean"},"datacenter_code":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":false,"duplikit":false,"sftpDomain":"sftp.pressable.com","phpVersion":null,"wordpressVersion":"Current Stable Release (6.2)","tags":[],"wpEnvironmentType":"staging","lightWeight404":false,"multisiteSupport":false}}}}}}}}}},"/sites/{site_id}/backups":{"get":{"tags":["sites"],"summary":"Backups List","description":"Get a list of available site backups for the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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}]}}}}}}}}},"/sites/{site_id}/backups/fs":{"get":{"tags":["sites"],"summary":"Filesystem Backups List","description":"Get a list of available site filesystem backups for the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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"}]}}}}}}}}},"/sites/{site_id}/backups/db":{"get":{"tags":["sites"],"summary":"Database Backups List","description":"Get a list of available site database backups for the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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"}]}}}}}}}}},"/sites/{site_id}/backups/{backup_id}":{"get":{"tags":["sites"],"summary":"Get Site Backup","description":"Download a specified site backup","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"backup_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/sites/{site_id}/restores":{"post":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filesystem_id":{"type":"integer"},"database_id":{"type":"integer"},"restore_on_site_id":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/sync":{"post":{"tags":["sites"],"summary":"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:","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"from_site_id":{"type":"integer"},"to_site_id":{"type":"integer"},"themes_directory":{"type":"boolean"},"plugins_directory":{"type":"boolean"},"uploads_directory":{"type":"boolean"},"wp_content_directory":{"type":"boolean"},"root_directory":{"type":"boolean"},"skip_http_check":{"type":"boolean"},"skip_robots_txt":{"type":"boolean"},"skip_maintenance_mode":{"type":"boolean"},"preserve_jetpack_licenses":{"type":"boolean"},"database":{"type":"boolean"},"wp_environment_type":{"type":"string"}}}}}},"parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{site_id}/collaborators":{"get":{"tags":["sites"],"summary":"Collaborator List","description":"Get a list of collaborators for the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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"}]}}}}}}}},"post":{"tags":["sites"],"summary":"Create Site Collaborator","description":"Create a new collaborator with the specified email on the specified site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"]}}}}}}}}}},"/sites/{site_id}/collaborators/{id}":{"get":{"tags":["sites"],"summary":"Get Site Collaborator","description":"Get site collaborator information.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}},"delete":{"tags":["sites"],"summary":"Delete Collaborator","description":"Delete a collaborator with the specified id.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"delete_wp_user":{"type":"boolean"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{site_id}/collaborators/{id}/wp-password-reset":{"put":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"string","example":"!WGhilzTwgAItI!q_GcyhF_o"}}}}}}}}},"/sites/{site_id}/domains":{"get":{"tags":["sites"],"summary":"Domain List","description":"Get a list of domains for a given site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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}]}}}}}}}},"post":{"tags":["sites"],"summary":"Add Domain","description":"Add a new domain to a site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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"]}]}}}}}}}}},"/sites/{site_id}/domains/{id}":{"get":{"tags":["sites"],"summary":"Get Domain","description":"Get domain information.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"]}}}}}}}}},"delete":{"tags":["sites"],"summary":"Delete Domain","description":"Delete a domain from a site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{site_id}/domains/{id}/primary":{"put":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"]}}}}}}}}}},"/sites/{site_id}/ftp":{"get":{"tags":["sites"],"summary":"Get SFTP User List","description":"Get a list of FTP users for the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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]"}]}}}}}}}}},"/sites/{site_id}/ftp/{username}":{"get":{"tags":["sites"],"summary":"Get SFTP User","description":"Get SFTP user by Id for the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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]"}}}}}}}}}},"/sites/{site_id}/ftp/password/{username}":{"post":{"tags":["sites"],"summary":"Reset SFTP User Password","description":"Reset an FTP user password for the specified user and site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"string","example":"076b2818de6e39"}}}}}}}}},"/sites/{site_id}/jetpack":{"get":{"tags":["sites"],"summary":"Jetpack License Information","description":"Get the Jetpack license information for the specified site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"id":948,"siteId":1,"licenseKey":"premium_5bc9f55f12","issuedAt":1643659537,"revokedAt":null}}}}}}}}},"post":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{site_id}/statistics":{"get":{"tags":["sites"],"summary":"Statistics","description":"Get a list of statistics for a site. Data is updated once daily.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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}}}}}}}}}}}},"/sites/{id}/tags":{"post":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"},"tag_id":{"type":"integer"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"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,"sandbox":true,"duplikit":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}}}}}}}}},"delete":{"tags":["sites"],"summary":"Remove Tags","description":"Remove tags from your site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tag_ids":{"type":"array","items":{"type":"integer"}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"duplikit":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}}}}}}}}}},"/sites/{id}/notes":{"get":{"tags":["sites"],"summary":"Note List","description":"Get the notes attached to the requested site.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"per_page","schema":{"type":"integer"}},{"in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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":{"type":"object","example":{"currentPage":2,"nextPage":null,"lastPage":2,"perPage":1,"totalItems":2}}}}}}}}},"post":{"tags":["sites"],"summary":"Add Note","description":"Add notes to your site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string"},"body":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}}},"/sites/{site_id}/notes/{id}":{"get":{"tags":["sites"],"summary":"Get Note","description":"Get specified note for site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}},"put":{"tags":["sites"],"summary":"Update Note","description":"Update note for your site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string"},"body":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}},"delete":{"tags":["sites"],"summary":"Delete Note","description":"Delete a note from your site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{site_id}/wordpress/password-reset":{"put":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"string","example":"%Y6hDU%-Yu5okh5AvGN"}}}}}}}}},"/sites/{site_id}/wordpress/phpmyadmin":{"get":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"string","example":"https://pressable.com/_pma_login?timestamp=1646159015\u0026nonce=202733835103\u0026token=c47c6b938"}}}}}}}}},"/sites/{site_id}/wordpress/version":{"put":{"tags":["sites"],"summary":"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).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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,"sandbox":false,"duplikit":false,"sftpDomain":"sftp.pressable.com","phpVersion":"8.2","wordpressVersion":"Current Stable Release (6.2)","tags":[],"wpEnvironmentType":"staging","lightWeight404":true,"multisiteSupport":true}}}}}}}}}},"/sites/{site_id}/one_press_login":{"post":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"user_agent":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"url":"https://mydomain.com/wp-login.php?mpcp_token=MS00Mzg1OTNlOTYzMjNkMWY3NTEjk4NjYtODU1YWJlMzNmNjEwNI"}}}}}}}}}},"/sites/{id}/logs/php":{"get":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"scroll_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"logs":{"type":"array","items":{"type":"object"},"example":[{"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":{"type":"string","example":"FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5VGhlbkZldGNogAgWdGdWQWZTeHBUaGFJTG1fR0E0LVp2dwAAAAABPOLVFnZ6SFlEODV0UUt1bklUWGs0STdjbVEWeVNlaU56eDdRek9WRmhGQjJHZEk2dwAAAAAEdcDJFkhiWDJMaHc0UWdXbXNRME9uQUZLaHcWSUlDQnhTOGtScmlrMFR1OFM3azlFdwAAAAAEV8-iFnRMcHN2OGdMUmR1M0NROWxQeFp6ZGcWTVItdXJuSW1UVXFKZkhLWktIVDdDdwAAAAAEJkfNFn="}}}}}}}}},"/sites/{id}/logs/server":{"get":{"tags":["sites"],"summary":"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.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"scroll_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"request_type","schema":{"type":"string"}},{"in":"query","name":"user_ip","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"logs":{"type":"array","items":{"type":"object"},"example":[{"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":{"type":"string","example":"FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5VGhlbkZldGNogAgWdGdWQWZTeHBUaGFJTG1fR0E0LVp2dwAAAAABPOLVFnZ6SFlEODV0UUt1bklUWGs0STdjbVEWeVNlaU56eDdRek9WRmhGQjJHZEk2dwAAAAAEdcDJFkhiWDJMaHc0UWdXbXNRME9uQUZLaHcWSUlDQnhTOGtScmlrMFR1OFM3azlFdwAAAAAEV8-iFnRMcHN2OGdMUmR1M0NROWxQeFp6ZGcWTVItdXJuSW1UVXFKZkhLWktIVDdDdwAAAAAEJkfNFn="}}}}}}}}},"/sites/{id}/logs/activity":{"post":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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":{"type":"object","example":{"currentPage":1,"nextPage":2,"lastPage":7,"perPage":5,"totalItems":35}}}}}}}}}},"/activity/site-actions":{"get":{"tags":["activity"],"summary":"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.","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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"}]}}}}}}}}},"/sites/{site_id}/disconnect-ssh":{"get":{"tags":["sites"],"summary":"Disconnect SSH","description":"Terminate all SSH connections for a site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/reports/performance/latest":{"get":{"tags":["sites"],"summary":"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 .","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}}}},"/sites/{id}/reports/usage":{"get":{"tags":["sites"],"summary":"Site Usage Report","description":"Get the usage details for a given site.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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}}}]}}}}}}}}},"/sites/{id}/metrics":{"post":{"tags":["sites"],"summary":"Site Metrics","description":"Retrieve time series metrics for a given site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start_at":{"type":"string"},"metrics":{"type":"array","items":{"type":"string"}},"dimensions":{"type":"array","items":{"type":"string"}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"id":1,"name":"my-pressable-net","displayName":"my-pressable-net","url":"https://my-presssable-net.mystagingwebsite.com","search":{"startAt":1741175460,"endAt":1741190220,"resolution":180,"metrics":["requests_persec","response_bytes_persec"],"dimensions":["page_is_cached"]},"periods":[{"timestamp":1741177800,"page_is_cached":{"requests_persec":{"false":0.016666666666666666},"response_bytes_persec":{"false":82.07222222222222}}},{"timestamp":1741178340,"page_is_cached":{"requests_persec":{"false":0.005555555555555556},"response_bytes_persec":{"false":81.72777777777777}}},{"timestamp":1741179240,"page_is_cached":{"requests_persec":{"false":0.011111111111111112},"response_bytes_persec":{"false":81.7388888888889}}}]}}}}}}}}}},"/sites/{id}/php_fs_permissions":{"put":{"tags":["sites"],"summary":"Set PHP File System Permissions","description":"PHP FS Permissions control how a site's filesystem is mounted during PHP-handled HTTP requests. This setting determines whether PHP can read from and/or write to the site's files.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"php_fs_permission":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"There was a problem processing your request."},"errors":{"type":"array","items":{"type":"string"},"example":["PHP FS permission is not valid. Must be one of the following: rw, ro, or loggedin"]}}}}}}}}},"/sites/{site_id}/firewall_rules":{"get":{"tags":["sites"],"summary":"List Egress Firewall Rules","description":"List the egress firewall rules for a site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"An internal error occurred while processing your request. Please try again."}}}}}}}}},"/sites/{site_id}/firewall_rules/{firewall_rule_id}":{"get":{"tags":["sites"],"summary":"Show Egress Firewall Rules","description":"Show an egress firewall rules for a site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"firewall_rule_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"An internal error occurred while processing your request. Please try again."}}}}}}}},"delete":{"tags":["sites"],"summary":"Delete Egress Firewall Rules","description":"Delete an egress firewall rule for a site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"firewall_rule_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"We could not locate the requested resources."}}}}}}}}},"/sites/{site_id}/firewall_rules/create":{"post":{"tags":["sites"],"summary":"Create Egress Firewall Rule","description":"Create an egress firewall rule for a site","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"destination":{"type":"string"},"port":{"type":"string"},"protocol":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"There was a problem processing your request."},"errors":{"type":"array","items":{"type":"string"},"example":["Firewall rule already exists"]}}}}}}}}},"/sites/{site_id}/firewall_rules/refresh":{"post":{"tags":["sites"],"summary":"Refresh Egress Firewall Rules","description":"Refresh egress firewall rules for a site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"An internal error occurred while processing your request. Please try again."}}}}}}}}},"/sites/{site_id}/apm/activate":{"post":{"tags":["sites"],"summary":"Activate APM","description":"Activate Application Performance Monitoring for a site","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apm_duration":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"There was a problem processing your request."},"errors":{"type":"array","items":{"type":"string"},"example":["APM is already active for this site"]}}}}}}}}},"/sites/{site_id}/apm/deactivate":{"post":{"tags":["sites"],"summary":"Deactivate APM","description":"Deactivate Application Performance Monitoring for a site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"There was a problem processing your request."},"errors":{"type":"array","items":{"type":"string"},"example":["APM is already deactivated for this site"]}}}}}}}}},"/http://localhost:3001//sites/{site_id}/apm/url":{"get":{"tags":["http:"],"summary":"Get APM URL","description":"Get the Application Performance Monitoring trace URL for a site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"We could not locate the requested resources."},"errors":{"type":"array","items":{"type":"string"},"example":["No APM traces available for this site"]}}}}}}}}},"/sites/{site_id}/cron_jobs/{id}":{"delete":{"tags":["sites"],"summary":"Cron Jobs","description":"Manage scheduled tasks (cron jobs) for your site.","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/usage/filesystem":{"put":{"tags":["sites"],"summary":"Set Filesystem Usage Limit","description":"Set a maximum filesystem usage limit for your site along with a warning threshold. When site storage approaches or exceeds these limits, you'll receive alerts. Setting these limits helps you proactively manage your site's storage.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer"},"warning_headroom":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"favorite":false,"fileSystemUsageBytes":13737418240,"databaseUsageBytes":147483648,"maxFileSystemUsageBytes":10737418240,"warningHeadroomFileSystemUsageBytes":2147483648,"maxDatabaseUsageBytes":null,"warningHeadroomDatabaseUsageBytes":null,"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,"sandbox":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}}}}}}}}}},"/sites/{id}/usage/database":{"put":{"tags":["sites"],"summary":"Set Database Usage Limit","description":"Set a maximum database usage limit for your site along with a warning threshold. These limits help you monitor database growth and receive alerts when approaching capacity constraints.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer"},"warning_headroom":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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":null,"favorite":false,"fileSystemUsageBytes":13737418240,"databaseUsageBytes":7368709120,"maxFileSystemUsageBytes":null,"warningHeadroomFileSystemUsageBytes":null,"maxDatabaseUsageBytes":5368709120,"warningHeadroomDatabaseUsageBytes":1073741824,"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,"sandbox":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}}}}}}}}}},"/sites/{id}/themes":{"get":{"tags":["sites"],"summary":"Theme List","description":"Get a list of themes for the specified site.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"array","items":{"type":"object"},"example":[{"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"}]}}}}}}}},"post":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"themes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"version":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}},"put":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"themes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"version":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}},"delete":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"themes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/themes/activate":{"put":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"themes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/wordpress/users":{"get":{"tags":["sites"],"summary":"WordPress User List","description":"This endpoint retrieves a list of WordPress users from your site.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"page","schema":{"type":"integer"}},{"in":"query","name":"per_page","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"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"}}}}}}}}},"post":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"object","example":{"id":"10","email":"[email protected]","password":"1bb31b9bfee1e41644c8eec17c2d9bae"}}}}}}}}}},"/sites/{id}/wordpress/users/password-reset":{"put":{"tags":["sites"],"summary":"Update WordPress User Password","description":"This endpoint allows for the modification of a WordPress user's password directly on your site.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"integer"},"password":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"},"data":{"type":"string","example":"my_new_password"}}}}}}}}},"/sites/{id}/wordpress/wpcli":{"post":{"tags":["sites"],"summary":"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.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"commands":{"type":"array","items":{"type":"string"}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}},"/sites/{id}/wordpress/commands":{"post":{"tags":["sites"],"summary":"Bash Commands","description":"This endpoint allows you to run Bash commands via the API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"commands":{"type":"array","items":{"type":"string"}}}}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Success"}}}}}}}}}}}