Servebolt API (v1)
Submit feedback
Servebolt API (v1)
  • Introduction
  • Auth
  • Bolts
  • Environments
  • Locations
  • Databases
  • Cronjobs
  • SSH Keys
  • Certificates
  • Billing
  • Profile
logoPowered by Apidog

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:

curl -X GET "https://servebolt-api-v1.apidog.io/v1/your-endpoint" \
     -H "Authorization: Bearer YOUR_API_TOKEN"

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.

Last modified: 4 months ago