Servebolt API (v1)
Submit feedback
Submit feedback
  1. Domains
  • Introduction
  • Auth
    • Signup
    • Login
    • User Info
    • Heartbeat
    • Refresh Token
    • Reset Password
    • Resend SMS verification code
    • Verify your phone number
    • MFA Challenge (OTP)
  • 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
      • Sites Dynamic Requests Statistics
      • Sites TTFB Statistics
      • Sites Storage Statistics
    • List Bolts
    • Bolt Name Validate
    • Available CMS
    • Create Bolt
    • Get Bolt
    • Get Bolt Sites
    • Update Bolt
    • Archive Bolt
    • Available PHP Versions
    • Get Bolt Subscription
    • Bolt Usage
    • Update Bolt Quota
    • Transfer Bolt Request
    • Transfer Bolt Request Copy
  • Sites
    • Git
      • Get Git Status
      • Create Git Configuration
      • Update Git Configuration
      • Delete Git Repository
      • Deploy Git Repository
      • Regenerate Git Public Key
      • Retrieve Git Repository Branches
      • Test Git Repository Connection
    • Domains
      • List Domains
        GET
      • List Site Domains
        GET
      • Get Site Domain
        GET
      • Create Domain Validation
        POST
      • Create Site Domain
        POST
      • Delete Domain
        DELETE
      • Get Domain Certificates
        GET
      • Link Certificate to Domain
        POST
      • Unlink Certificate from Domain
        POST
    • Logs
      • Get Apache Access Logs
      • Get Apache Error Logs
      • Get Cron Errors
    • List Sites
      GET
    • Create Site
      POST
    • Get Site
      GET
    • Update Site
      PATCH
    • Delete Site
      DELETE
    • Purge Site Cache
      POST
    • List Site Cronjobs
      GET
    • Get Site Statistics
      GET
    • Get Environment Available Settings
      GET
    • Get Site Available PHP Versions
      GET
    • Get Site Usage
      GET
    • Get Site SSH Accesses
      GET
    • Create Site SSH Access
      POST
    • Remove Site SSH Access
      DELETE
    • List Site Databases
      GET
    • Toggle Site Dev Mode
      POST
    • Site Install Wordpress
      POST
    • Site Optimize Wordpress
      POST
  • 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. Domains

List Domains

GET
https://api.servebolt.io/v1/domains
Get all the domains in your account.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
q
string 
optional
Search query parameter
Header Params
Accept
string 
required
Example:
application/json
Content-Type
string 
required
Example:
application/json

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 GET 'https://api.servebolt.io/v1/domains?q' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Responses

🟢200OK
application/json
Body
data
array [object {4}] 
required
id
integer 
required
type
string 
required
attributes
object 
required
relationships
object 
required
links
object 
required
first
string 
required
last
string 
required
prev
null 
required
next
string 
required
meta
object 
required
current_page
integer 
required
from
integer 
required
last_page
integer 
required
links
array [object {3}] 
required
path
string 
required
per_page
integer 
required
to
integer 
required
total
integer 
required
Example
{
    "data": [
        {
            "id": 2476,
            "type": "domain",
            "attributes": {
                "boltId": 8944,
                "environmentId": 1702,
                "name": "domain.com",
                "sslId": 217,
                "sslType": 1,
                "deletable": true,
                "tags": []
            },
            "relationships": {
                "certificates": [
                    {
                        "id": 217,
                        "type": "certificates",
                        "attributes": {
                            "type": "SELFSIGNED",
                            "expires": "2025-04-19T21:59:59Z"
                        }
                    }
                ],
                "environment": {
                    "data": {
                        "id": 1702,
                        "attributes": {
                            "title": "Test"
                        }
                    }
                }
            }
        },
        {
            "id": 2266,
            "type": "domain",
            "attributes": {
                "boltId": 8853,
                "environmentId": 1604,
                "name": "asub.domain.com",
                "sslId": null,
                "sslType": 1,
                "deletable": true,
                "tags": []
            },
            "relationships": {
                "certificates": [],
                "environment": {
                    "data": {
                        "id": 1604,
                        "attributes": {
                            "title": "Hihello"
                        }
                    }
                }
            }
        }
    ],
    "links": {
        "first": "https://xxx/v1/domains?page=1",
        "last": "https://xxx/v1/domains?page=2",
        "prev": null,
        "next": "https://xxx/v1/domains?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://xxx/v1/domains?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://xxx/v1/domains?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://xxx/v1/domains?page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://xxx/v1/domains",
        "per_page": 15,
        "to": 15,
        "total": 17
    }
}
Modified at 2024-07-09 13:41:06
Previous
Test Git Repository Connection
Next
List Site Domains
Built with