Servebolt API (v1)
Submit feedback
Submit feedback
  1. Auth
  • 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
  1. Auth

Login

POST
https://api.servebolt.io/v1/auth/login
Authenticate and retrieve an access token for your account. Currently, the access tokens expire in 30 days.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Accept
string 
required
Example:
application/json
Content-Type
string 
required
Example:
application/json
Body Params application/x-www-form-urlencoded
username
string 
required
The email used to sign up.
Example:
{{USERNAME}}
password
string 
required
Example:
{{PASSWORD}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.servebolt.io/v1/auth/login' \
--header 'Accept: application/json' \
--data-urlencode 'username=' \
--data-urlencode 'password='

Responses

🟢200Success
application/json
Body
data
object 
required
access_token
string 
required
The access token needed to make API calls.
refresh_token
string 
required
id_token
string 
required
scope
string 
required
expires_in
integer 
required
The number of seconds the token is valid for.
token_type
string 
required
Example:
Bearer
accountId
integer 
required
accountEmail
string 
required
accountName
string 
required
accountPicture
string 
required
intercomUserHash
string 
required
Example
{
  "data": {
    "access_token": "string",
    "refresh_token": "string",
    "id_token": "string",
    "scope": "string",
    "expires_in": 0,
    "token_type": "Bearer",
    "accountId": 0,
    "accountEmail": "string",
    "accountName": "string",
    "accountPicture": "string",
    "intercomUserHash": "string"
  }
}
🟠401Unauthorized
Modified at 2024-07-04 09:45:42
Previous
Signup
Next
User Info
Built with