Servebolt API (v1)
Submit feedback
Submit feedback
    • Introduction
    • Auth
      • Signup
        POST
      • Login
        POST
      • User Info
        GET
      • Heartbeat
        GET
      • Refresh Token
        POST
      • Reset Password
        POST
      • Resend SMS verification code
        POST
      • Verify your phone number
        POST
      • MFA Challenge (OTP)
        POST
    • Bolts
      • Access
        • Invite User Contact
        • List Contacts
        • Update Contact Role
        • Delete Contact
      • Databases
        • List Bolt Databases
        • Get Bolt Database
        • Create Bolt Database
        • Update Bolt Database
        • Delete Bolt Database
      • Statistics
        • Dynamic Requests Statistics
        • TTFB Statistics
        • Storage Statistics
        • Content Type Statistics
        • Cache Statistics
        • Environments Dynamic Requests Statistics
        • Environments TTFB Statistics
        • Environments Storage Statistics
      • List Bolts
        GET
      • Bolt Name Validate
        POST
      • Available CMS
        GET
      • Create Bolt
        POST
      • Get Bolt
        GET
      • Get Bolt Environments
        GET
      • Update Bolt
        PUT
      • Archive Bolt
        DELETE
      • Available PHP Versions
        GET
      • Get Bolt Subscription
        GET
      • Bolt Usage
        GET
      • Update Bolt Quota
        POST
      • Transfer Bolt Request
        POST
      • Transfer Bolt Request Copy
        GET
    • Environments
      • Git
        • Get Environment Git Status
        • Create Git Configuration
        • Update Git Configuration
        • Delete Environment Git Repository
        • Deploy Git Repository
        • Regenerate Git Public Key
        • Retrieve Git Repository Branches
        • Test Git Repository Connection
      • Domains
        • List Domains
        • List Environment Domains
        • Get Environment Domain
        • Create Domain Validation
        • Create Environment Domain
        • Delete Domain
        • Get Domain Certificates
        • Link Certificate to Domain
        • Unlink Certificate from Domain
      • Logs
        • Get Environment Apache Access Logs
        • Get Environment Apache Error Logs
        • Get Environment Cron Errors
      • List Environments
      • Create Environment
      • Get Environment
      • Update Environment
      • Delete Environment
      • Purge Environment Cache
      • List Environment Cronjobs
      • Get Environment Statistics
      • Get Environment Available Settings
      • Get Environment PHP Versions
      • Get Environment Usage
      • Get Environment SSH Accesses
      • Create Environment SSH Access
      • Remove Environment SSH Access
      • List Environment Databases
      • Toggle Environment Dev Mode
      • Environment Install Wordpress
      • Environment Optimize Wordpress
    • Locations
      • List Locations
      • Check SL8 Availability
      • Available Countries
    • Databases
      • List Databases
      • Get Database
      • Create Database
      • Update Database
      • Delete Database
      • Link Database
      • Unlink Database
      • Get Slow Queries
    • Cronjobs
      • List Cronjobs
      • Create Cronjob
      • Get Cronjob
      • Update Cronjob
      • Delete Cronjob
    • SSH Keys
      • List SSH Keys
      • Add a new SSH Key
      • Get SSH Key
      • Delete SSH Key
    • Certificates
      • List Certificate Orders
      • Get Certificate Order
      • Order new Certificate
      • Store custom certificate
      • Update Auto-Renewal
      • Verify DNS challenge
      • Delete Certificate Order
    • Billing
      • Pricing Calculator
      • Get Billing Customer Info
      • Update Bolt Subscription
      • List Invoices
      • Download Invoice
    • Profile
      • Get User Profile
      • Update User Profile
      • Update Profile Picture
      • Delete Profile Picture

    Introduction

    Welcome to the Servebolt API (v1)#

    Welcome to the Servebolt API documentation. Our API is currently under continuous development and is in a testing phase. We encourage you to start exploring and testing the API, and your feedback is invaluable to us during this stage.

    Overview#

    The Servebolt API offers a comprehensive set of endpoints for managing various aspects of your Servebolt environments. With this API, you can automate and streamline operations, integrate Servebolt capabilities into your applications, and enhance your workflows.

    Key Features#

    Environment Management: Create, manage, and configure environments.
    Bolts: Handle bolts efficiently.
    Locations and Databases: Manage server locations and databases.
    Cronjobs and SSH Keys: Automate tasks and manage access.
    Certificates and Billing: Secure your applications and manage billing information.
    User Profile Management: Create and manage

    Getting Started#

    To begin using the Servebolt API, follow these steps:

    1. Authentication#

    To retrieve an access token to use with protected endpoints on the Servebolt API, you need to authenticate by sending a POST request to the /v1/auth/login endpoint (documentation). Include your username and password in the request body. Upon successful authentication, you will receive a JSON response containing the access_token, refresh_token, and other relevant information. The access_token is then used in the Authorization header of subsequent requests to access protected endpoints.
    Alternatively, you can use your API key found in your profile. The key must be used in a custom X-API-Key header for all requests.

    2. Making Your First Request#

    With your API token, you can start making requests. Here's an example using cURL:

    3. Explore the API Endpoints#

    Our documentation includes detailed information about each endpoint, including required parameters, example requests, and response formats. Start exploring to see what you can achieve in the left sidebar.

    Feedback and Support#

    Your feedback is crucial for us. If you have any questions or run into issues, visit our Contact page to start a chat or email.
    Next
    Auth
    Built with