Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Update user
Search
JUMP TO
Overview
Introduction
Rocket.net API
Billing
List Billing Addresses
get
Create Billing Address
post
Get Billing Address
get
Update Billing Address
patch
Delete Billing Address
delete
List Invoices
get
Get Invoice
get
Record a Credit Card Payment
post
Update a PayPal Subscription
patch
Create a PayPal Subscription
post
Download Invoice PDF
get
List Payment Methods
get
Add Credit Card
post
Get Payment Method
get
Delete Payment Method
delete
Update Payment Method
patch
Create Credit Card Setup Intent
post
List Available Products
get
Authentication
Authenticate user and generate JWT token
post
Sites
List sites
get
Create new site
post
Get information about site from system
get
Delete site from system
delete
Update site properties.
patch
Generate token valid for accessing site operations
post
List Site locations (including restricted)
get
Clone a site (via background task)
post
Get password and username for site.
get
List Site locations
get
Lock a site so that no modifications can be made
post
Unlock a site so that modifications can be made again
delete
Get SSO link for phpMyAdmin account
get
Get site settings.
get
Update site settings.
patch
Create new staging site for given site (via background task)
post
Delete staging site for given site.
delete
Publish staging site as an active site (via background task)
post
List Site Tasks
get
Get site usage.
get
Site Templates
Create new site template
post
List Site Templates
get
[Deprecated]: Create new site template
post
Get Site Templates
get
Delete Site Templates
delete
Create new site from a site template
post
Domains
List additional domains (aliases) for the site
get
Create additional domain.
post
Delete additional domain
delete
Get site main domain info
get
Set a domain for a Site
post
Update maindomain validation method or SSL CA
patch
Replace current maindomain with different one
put
Change existing prefix for domain
patch
Force validation status recheck
get
Checks the status of the maindomain, any alternate maindomains, and additional domains
get
CDN Cache
Purge files from cache on cloudflare
post
Purge all files from single domain from cache on cloudflare
post
FTP Accounts
List Ftp Accounts
get
Create new ftp account
post
Update ftp account
patch
Delete ftp account
delete
Plugins
List available featured plugins
get
List installed WordPress plugins on account
get
Install new WordPress plugins to site
post
Activate or deactivate WordPress plugins on given site
patch
Update WordPress plugins on given site
put
Delete WordPress plugins from given site
delete
Search for WordPress plugins that can be installed
get
Themes
List installed Wordpress themes on account
get
Install new WordPress themes to site
post
Activate or deactivate WordPress themes on given site
patch
Update WordPress themes on given site
put
Delete WordPress theme from site
delete
Search for WordPress themes that can be installed
get
Reporting
Retrieve CDN requests report
get
Retrieve CDN cache-status report
get
Retrieve CDN cache-content report.
get
[Deprecated] Retrieve cdn cache-top report.
get
Retrieve cdn visitors report.
get
List WAF Events
get
Retrieve WAF events source report.
get
Retrieve WAF firewall events report.
get
Retrieve WAF events services report.
get
Retrieve WAF events time report.
get
[Deprecated]: List WAF Events
get
Get top usage bandwidth report.
get
Get usage bandwidth report.
get
List Access Logs
get
[Deprecated] List Access Logs
get
CDN Request Volume by Source
get
Total requests from all sources
get
SSH Keys
List SSH keys for given site.
get
Import SSH key for given site.
post
Delete SSH key for given site.
delete
Activate SSH key for given site.
post
Deactivate SSH key for given site.
post
View SSH key info for given site.
get
Visitors
Get unique visitors statistics for user account.
get
Get unique visitors statistics for given site.
get
Bandwidth
Get bandwidth usage statistics for user account.
get
Get bandwidth usage statistics for given site.
get
Backups
Create a new backup for given site.
post
Get a list of backups for site
get
Download given backup for site
get
Delete given backup for site from the system.
delete
Restore a backup for given site (via background task)
post
List automated backups
get
Restore existing automated restore point (via background task)
post
Restore existing automated restore point database
post
Restore existing automated restore point files
post
Files
List Site Files
get
[Deprecated] List files in a site installation.
get
Upload a file to the site installation.
post
Save contents of a file to the site installation.
put
Delete file from a site installation.
delete
Extract a file.
post
Compress files or folders.
post
Change file permissions.
patch
Download contents of a given file.
get
Create folder in a site installation.
post
View contents of a given file.
get
Account
Request that your Rocket.net account be cancelled
post
Get Current Hosting Plan
get
Change Account's Hosting Plan
put
Set Hosting Plan
post
Get user information
get
Update user account settings
patch
Get unique usage statistics for user account.
get
Get a cookie to allow for access to billing data
post
Set a new password for your account
post
Get a list of account level tasks
get
Activity
Stops events logging.
post
Starts events logging.
post
Insert new event into system.
post
List Activity Events
get
Get event for a site installation with event id.
get
Delete event from a site installation.
delete
Site Users
List all the site users for a Site
get
Send invite to site user.
post
Accept invite to site.
get
Accept invite to site.
post
Remove site access for site user.
delete
Send re-invite to site user.
post
Create new site user.
post
List all the site for user.
get
Login as a site user.
post
Reset password for the site user.
post
Update site user.
patch
Create or update password for the site user.
post
Password Protection
Get site password protection status.
get
Enable site password protection.
post
Disable site password protection.
delete
List site password protection users
get
Add site password protection user.
post
Remove site password protection user.
delete
Password Strength
Check strength of the given password.
post
Check strength of the given password.
post
Account Users
Create new user who can access your Rocket.net account. An email will be sent for them to set their password.
post
List all users in your account
get
Remove a User from your account
delete
Get information about a specific user in your account.
get
Update user
patch
Create first time password for the Account User
post
Re-send invite email to User
post
Accept an invitation to help manage a Rocket.net account
get
ShopShield
List ShopShield URIs for a site
get
Enable ShopShield for a URI
post
Disable ShopShield for a URI
delete
Get ShopShield URI Details
get
WordPress
Execute cli command on wp installation ([Deprecated])
post
Get SSO link for wordpress account
get
Get Status of WordPress for the site
get
Execute wp cli command on site.
post
Powered by
Update user
patch
https://api.rocket.net/v1/users/
{user_id}
For a given user, update their information
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!