# Servebolt API (v1) ## Docs - [Introduction](https://docs.servebolt.io/doc-468427.md): - [Auth](https://docs.servebolt.io/folder-1075618.md): ## API Docs - Auth [Signup](https://docs.servebolt.io/api-6626571.md): Create a new account on Servebolt. - Auth [Login](https://docs.servebolt.io/api-6270910.md): Authenticate and retrieve an access token for your account. Currently, the access tokens expire in 30 days. - Auth [User Info](https://docs.servebolt.io/api-6270935.md): Get user information associated with the provided access token. - Auth [Heartbeat](https://docs.servebolt.io/api-8496272.md): An endpoint to test your authentication on the Servebolt API in a simple and fast request. - Auth [Refresh Token](https://docs.servebolt.io/api-6626570.md): Refresh a provided access token. By inputting both access_token(in header) and refresh_token. You can retrieve a new access token that expires in 30 days. - Auth [Reset Password](https://docs.servebolt.io/api-6626572.md): Request a password reset for your account, using the email you signed up with. This endpoint does not require authentication. - Auth [Resend SMS verification code](https://docs.servebolt.io/api-6626591.md): If needed, using only your access token, you can request a new SMS code to verify your phone number. - Auth [Verify your phone number](https://docs.servebolt.io/api-6626592.md): Use the received SMS code to verify your phone number. - Auth [MFA Challenge (OTP)](https://docs.servebolt.io/api-13629606.md): If you have MFA enabled on your account, the *Login* endpoint will ask you to complete the authentication with an OTP challenge. You can use this endpoint to complete the MFA challenge and get a usable access token. - Bolts > Access [Invite User Contact](https://docs.servebolt.io/api-6626739.md): Invite a user to a Bolt. Available roles are technical contact and developer. - Bolts > Access [List Contacts](https://docs.servebolt.io/api-6626740.md): List a Bolt's users. - Bolts > Access [Update Contact Role](https://docs.servebolt.io/api-6626741.md): Update the role of a Bolt's user. - Bolts > Access [Delete Contact](https://docs.servebolt.io/api-6626742.md): Remove a user from a Bolt. **Note:** this does not delete the user from the system. - Bolts > Databases [List Bolt Databases](https://docs.servebolt.io/api-6626746.md): List all databases associated with a Bolt. - Bolts > Databases [Get Bolt Database](https://docs.servebolt.io/api-6626748.md): Get the details of a database. - Bolts > Databases [Create Bolt Database](https://docs.servebolt.io/api-6626747.md): Add a new database to a Bolt. - Bolts > Databases [Update Bolt Database](https://docs.servebolt.io/api-6626749.md): Update the information of a database. - Bolts > Databases [Delete Bolt Database](https://docs.servebolt.io/api-6626751.md): Delete a database. **Warning:** no data will be preserved! - Bolts > Statistics [Dynamic Requests Statistics](https://docs.servebolt.io/api-6626753.md): Get a Bolt's dynamic request statistics. - Bolts > Statistics [TTFB Statistics](https://docs.servebolt.io/api-6626754.md): Get a Bolt's TTFB statistics. - Bolts > Statistics [Storage Statistics](https://docs.servebolt.io/api-6626755.md): Get a Bolt's storage statistics. - Bolts > Statistics [Content Type Statistics](https://docs.servebolt.io/api-6626756.md): Get a Bolt's content type statistics. - Bolts > Statistics [Cache Statistics](https://docs.servebolt.io/api-6626757.md): Get a Bolt's cache statistics. - Bolts > Statistics [Environments Dynamic Requests Statistics](https://docs.servebolt.io/api-6626758.md): Get a Bolt's dynamic request statistics per environment. - Bolts > Statistics [Environments TTFB Statistics](https://docs.servebolt.io/api-6626759.md): Get a Bolt's TTFB statistics per environment. - Bolts > Statistics [Environments Storage Statistics](https://docs.servebolt.io/api-6626760.md): Get a Bolt's storage statistics per environment. - Bolts [List Bolts](https://docs.servebolt.io/api-6626732.md): List all the Bolts you have access to. - Bolts [Bolt Name Validate](https://docs.servebolt.io/api-6626730.md): Validate a bolt name to know if it will be accepted by the system. - Bolts [Available CMS](https://docs.servebolt.io/api-6626805.md): List all CMS supported by Servebolt. - Bolts [Create Bolt](https://docs.servebolt.io/api-6626733.md): Create a new free trial Bolt. - Bolts [Get Bolt](https://docs.servebolt.io/api-6626734.md): Get the details of a Bolt. - Bolts [Get Bolt Environments](https://docs.servebolt.io/api-6626752.md): List the environments of a Bolt. - Bolts [Update Bolt](https://docs.servebolt.io/api-6626735.md): Update the details of a Bolt. - Bolts [Archive Bolt](https://docs.servebolt.io/api-6626737.md): Archive a Bolt. **Note:** when a Bolt is archived all the environments and domains are disabled and the data retained for *7 days*. Contact our Support team if you need to restore an archived Bolt. - Bolts [Available PHP Versions](https://docs.servebolt.io/api-6626743.md): Get all available PHP versions for a Bolt. - Bolts [Get Bolt Subscription](https://docs.servebolt.io/api-6626744.md): Get the current billing subscription of a Bolt. - Bolts [Bolt Usage](https://docs.servebolt.io/api-6626728.md): Get a Bolt's usage information. - Bolts [Update Bolt Quota](https://docs.servebolt.io/api-6626745.md): Update a Bolt's max storage. **This endpoint is only available for Bolts on dedicated servers.** - Bolts [Transfer Bolt Request](https://docs.servebolt.io/api-12969185.md): Create a transfer request torwards another user of the target bolt. - Bolts [Transfer Bolt Request Copy](https://docs.servebolt.io/api-13612020.md): Create a transfer request torwards another user of the target bolt. - Environments > Git [Get Environment Git Status](https://docs.servebolt.io/api-6626776.md): Get an environment's git configuration. - Environments > Git [Create Git Configuration](https://docs.servebolt.io/api-6626777.md): Configure git for an environment. - Environments > Git [Update Git Configuration](https://docs.servebolt.io/api-6626778.md): Update the git configuration of an environment. - Environments > Git [Delete Environment Git Repository](https://docs.servebolt.io/api-6626779.md): Delete the git configuration of an environment. **Note:** files on the environment will not be touched. - Environments > Git [Deploy Git Repository](https://docs.servebolt.io/api-6626581.md): Trigger a git deployment on an environment. - Environments > Git [Regenerate Git Public Key](https://docs.servebolt.io/api-6626780.md): Regenerate the git public key needed for deployments. - Environments > Git [Retrieve Git Repository Branches](https://docs.servebolt.io/api-12969107.md): Retrieve a list of all the branches in the configured repository - Environments > Git [Test Git Repository Connection](https://docs.servebolt.io/api-12969156.md): Test if the server is allowed to reach the remote repository. This is useful to check if the public key is installed correctly on the repository. - Environments > Domains [List Domains](https://docs.servebolt.io/api-6626769.md): Get all the domains in your account. - Environments > Domains [List Environment Domains](https://docs.servebolt.io/api-6626781.md): Get an environment's domains. - Environments > Domains [Get Environment Domain](https://docs.servebolt.io/api-6626782.md): Get an environment's specific domain. - Environments > Domains [Create Domain Validation](https://docs.servebolt.io/api-6626783.md): Check whether a domain can be added to an environment. - Environments > Domains [Create Environment Domain](https://docs.servebolt.io/api-6626784.md): Add a domain to an environment. - Environments > Domains [Delete Domain](https://docs.servebolt.io/api-6626785.md): Delete an environment's domain. - Environments > Domains [Get Domain Certificates](https://docs.servebolt.io/api-6626786.md): Get all certificates linked to a domain in an environment. - Environments > Domains [Link Certificate to Domain](https://docs.servebolt.io/api-6626787.md): Enable a certificate on a domain in an environment. - Environments > Domains [Unlink Certificate from Domain](https://docs.servebolt.io/api-6626788.md): Disable a certificate on a domain in an environment. - Environments > Logs [Get Environment Apache Access Logs](https://docs.servebolt.io/api-6626773.md): Get an environment's access logs. - Environments > Logs [Get Environment Apache Error Logs](https://docs.servebolt.io/api-6626774.md): Get an environment's error logs. - Environments > Logs [Get Environment Cron Errors](https://docs.servebolt.io/api-6626775.md): Get an environment's cron error logs. - Environments [List Environments](https://docs.servebolt.io/api-6626573.md): List all the environments of all Bolts in your account. - Environments [Create Environment](https://docs.servebolt.io/api-6626574.md): Create a new environment in a Bolt. - Environments [Get Environment](https://docs.servebolt.io/api-6626575.md): Get the details of an environment. - Environments [Update Environment](https://docs.servebolt.io/api-6626576.md): Update an environment's configuration. - Environments [Delete Environment](https://docs.servebolt.io/api-6626577.md): Delete an environment and all its content. - Environments [Purge Environment Cache](https://docs.servebolt.io/api-6626578.md): #### Purge an environment's HTTP and CloudFlare cache by prefix, host, cache tag or file path. - Environments [List Environment Cronjobs](https://docs.servebolt.io/api-6626579.md): List an environment's cronjobs. - Environments [Get Environment Statistics](https://docs.servebolt.io/api-6626770.md): Get an environment's statistics. - Environments [Get Environment Available Settings](https://docs.servebolt.io/api-6626771.md): Gets all the available settings that can be updated about an environment. - Environments [Get Environment PHP Versions](https://docs.servebolt.io/api-6626797.md): Get all available PHP versions for an environment. - Environments [Get Environment Usage](https://docs.servebolt.io/api-6626772.md): Get an environment's current usage. - Environments [Get Environment SSH Accesses](https://docs.servebolt.io/api-6626789.md): Get all the SSH keys that have access to an environment. - Environments [Create Environment SSH Access](https://docs.servebolt.io/api-6626790.md): Grant SSH access to an environment for an SSH key. - Environments [Remove Environment SSH Access](https://docs.servebolt.io/api-6626791.md): Revoke SSH access to an environment for an SSH key. - Environments [List Environment Databases](https://docs.servebolt.io/api-6626792.md): List all databases linked to an environment. - Environments [Toggle Environment Dev Mode](https://docs.servebolt.io/api-6626793.md): Toggle an environment's dev mode where cache will be disabled for 3 hours. - Environments [Environment Install Wordpress](https://docs.servebolt.io/api-6626794.md): Install wordpress on an environment. **Warning:** this can only be called on empty environments, if it contains files, the installation will fail. - Environments [Environment Optimize Wordpress](https://docs.servebolt.io/api-6626795.md): Apply a few optimizations on a wordpress installation for an environment. - Locations [List Locations](https://docs.servebolt.io/api-6626763.md): List all the available datacenters where you can create bolts. You can also find the list of all available PHP versions in each location. - Locations [Check SL8 Availability](https://docs.servebolt.io/api-6626764.md): Check if Servebolt Linux 8 is available on the given location. - Locations [Available Countries](https://docs.servebolt.io/api-6626820.md): All the available countries supported by the system. - Databases [List Databases](https://docs.servebolt.io/api-6626799.md): List all databases directly linked to your account. - Databases [Get Database](https://docs.servebolt.io/api-6626801.md): Get details for a database. - Databases [Create Database](https://docs.servebolt.io/api-6626800.md): Create a new database on a given bolt. *Warning:* the database password will be shown only once after the request is made. - Databases [Update Database](https://docs.servebolt.io/api-6626802.md): Update the details of a database. - Databases [Delete Database](https://docs.servebolt.io/api-6626804.md): Delete a database. **Warning:** no data will be preserved! - Databases [Link Database](https://docs.servebolt.io/api-6626761.md): Link a set of databases to a set of environments. - Databases [Unlink Database](https://docs.servebolt.io/api-6626762.md): Unlink a set of databases from a set of environments. - Databases [Get Slow Queries](https://docs.servebolt.io/api-6626798.md): List all logged slow queries for a database. - Cronjobs [List Cronjobs](https://docs.servebolt.io/api-6626586.md): List all the cronjobs across all your environments. - Cronjobs [Create Cronjob](https://docs.servebolt.io/api-6626587.md): Create a new cronjob on a specific environment. - Cronjobs [Get Cronjob](https://docs.servebolt.io/api-6626588.md): Get the details of a cronjob. - Cronjobs [Update Cronjob](https://docs.servebolt.io/api-6626589.md): Update the details of a cronjob. - Cronjobs [Delete Cronjob](https://docs.servebolt.io/api-6626590.md): Delete a cronjob. - SSH Keys [List SSH Keys](https://docs.servebolt.io/api-6626765.md): List all your SSH keys. - SSH Keys [Add a new SSH Key](https://docs.servebolt.io/api-6626766.md): Add a new SSH key to your account. - SSH Keys [Get SSH Key](https://docs.servebolt.io/api-6626767.md): Get details about a SSH Key - SSH Keys [Delete SSH Key](https://docs.servebolt.io/api-6626768.md): Delete one of your SSH keys. - Certificates [List Certificate Orders](https://docs.servebolt.io/api-6626720.md): List all certificate orders linked to your account. - Certificates [Get Certificate Order](https://docs.servebolt.io/api-6626722.md): Get the details of a certificate order. - Certificates [Order new Certificate](https://docs.servebolt.io/api-6626721.md): Place a new order for a SSL certificate. - Certificates [Store custom certificate](https://docs.servebolt.io/api-9989860.md): - Certificates [Update Auto-Renewal](https://docs.servebolt.io/api-6626723.md): Enable or disable the auto-renewal of a certificate order. - Certificates [Verify DNS challenge](https://docs.servebolt.io/api-6626724.md): Request a new DNS challenge for a certificate order. This endpoint needs to be called when all the required TXT DNS records have been created on the target domain. - Certificates [Delete Certificate Order](https://docs.servebolt.io/api-6626725.md): Delete a certificate order. **Note:** any SSL certificate that has been generated for this order will not be deleted, instead it will stop renewing. - Billing [Pricing Calculator](https://docs.servebolt.io/api-6626818.md): From different criteria, like storage needed and PHP memory limit, our pricing calculator can give you the best plans matching your requirements. - Billing [Get Billing Customer Info](https://docs.servebolt.io/api-6626806.md): Get your billing information. - Billing [Update Bolt Subscription](https://docs.servebolt.io/api-6626729.md): Change subscription, i.e. upgrade or downgrade your plan, or add extra addons, for a bolt. - Billing [List Invoices](https://docs.servebolt.io/api-6626716.md): Get all the available invoices of the account - Billing [Download Invoice](https://docs.servebolt.io/api-6626717.md): Get the PDF file of an invoice - Profile [Get User Profile](https://docs.servebolt.io/api-6626807.md): Get your profile information. - Profile [Update User Profile](https://docs.servebolt.io/api-6626808.md): Update your profile information. - Profile [Update Profile Picture](https://docs.servebolt.io/api-6626809.md): Upload your own profile picture. - Profile [Delete Profile Picture](https://docs.servebolt.io/api-6626810.md): Delete your current profile picture.