logo

Elestio (1.0.0)

Download OpenAPI specification:Download

Introduction

Elestio provide fully managed open-source services for a large catalog of 350+ softwares on a dedicated instance in less than 3 minutes. You can relax knowing that we are taking care of installation, configuration, encryption, backups, software & OS updates, live monitoring…and more! on scalable cloud infrastructure.

Elestio is available on 6 cloud providers, 80 regions, 25 countries and also on-premise or your own cloud provider.

No more DevOps. Deploy on any cloud or on-premise. Scalable & Secure. CI/CD Pipelines.

If you do not have an account yet, sign up now at Elestio.

Description

The Elestio REST API provides access to elest.io services. All requests and responses are in JSON format


AUTHENTICATION

checkAPIToken

To get your token, go to Elestio security tab, then click on Manage API Tokens > Create Token.
You will get a token similar to ggiKvqrHfpAhBofvjOtax4JI

You will need to call /api/auth/checkAPIToken to get a valid jwt.
You can then use this jwt to call all others API calls.

Request Body schema: application/json
email
string

User email address

token
string

User token generated for Authentication

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S"
}

SERVICES

Create a new service

Request Body schema: application/json
jwt
string

User jwt for Authentication

templateID
string

Template id of the service which user wants to create

serverType
string

Type of the service server.

datacenter
string

The datacenter from where the server will be hosted

serverName
string

Name of the server given by user

appid
string

Application id

data
string
support
string

Level of the support plan choosen for the server

projectId
string

Project id for the selected service

version
string

Version of service software

adminEmail
string

Email address of service owner/admin

deploymentServiceType
string
Enum: "normal" "restore" "clone"

The kind of operation you intend to carry out while deploying the VM. Normal refers to simply deploying a regular VM, restore to deploying a new VM from an old deleted VM (Only possible if you're deploying within 14 days of deletion and you don't choose to opt out of borg backup at that time), and clone to deploying a new copy of a running VM.

serviceType
string
Enum: "Service" "CICD" "LB"

The type of VM you're deploying. Service refers to a regular VM, CICD refers to a CI/CD pipeline target, and LB refers to a load balancer.

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "templateID": "38",
  • "serverType": "SMALL-1C-2G",
  • "datacenter": "fsnl",
  • "serverName": "ubuntu-3dfd",
  • "appid": "Cloudxx",
  • "data": "data",
  • "support": "level1",
  • "projectId": "17734567",
  • "version": "1",
  • "adminEmail": "[email protected]",
  • "deploymentServiceType": "normal",
  • "serviceType": "Service"
}

Response samples

Content type
application/json
{
  • "action": {
    },
  • "providerServerID": 12345678
}

List of services in a project

Request Body schema: application/json
jwt
string

User jwt token for Authentication

appid
string

Application id

projectId
string

Project id for selected service

isActiveService
string

If the service is running it will be true

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "appid": "Cloudxx",
  • "projectId": "17734567",
  • "isActiveService": "true"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get service information

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id of selected service

projectID
string

Project id of selected service

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "projectID": "123"
}

Response samples

Content type
application/json
{
  • "serviceInfos": [
    ]
}

List of softwares

Responses

Request samples 

curl --request GET \
  --url https://api.elest.io/api/servers/getTemplates

Response samples

Content type
application/json
{
  • "instances": [
    ]
}

List of servers

Responses

Request samples 

curl --request GET \
  --url https://api.elest.io/api/servers/getServerSizes

Response samples

Content type
application/json
{
  • "instances": [
    ]
}

Delete a service

Request Body schema: application/json
vmID
string

Virtual machine id of selected service

jwt
string

User jwt token for Authentication

isDeleteServiceWithBackup
string

It will be true if user don't want to keep any backups

Responses

Request samples

Content type
application/json
{
  • "vmID": "123456789",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "isDeleteServiceWithBackup": "false"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

Performs an action

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id of selected service

action
string
Enum: "reboot" "reset" "shutdown" "poweroff" "poweron" "getServiceVolume" "createServiceVolume" "manageServiceVolumeProtection" "..."

Action to be performed on server

Responses

Request samples

Content type
application/json
Example
Reboot Server
Reboot Server
Reset Server
Shutdown Server
Power Down Server
Power Up Server
Get Volumes for the service
Create a new Volume for a service
To Turn On/Off projection for Volume
Resize Volume.
Unlink Volume.
Delete Service Volume
Activate Termination Protection for Service.
Deactivate Termination Protection for Service.
Disable Service OS auto updates
Enable Service OS auto updates
Update Server OS.
Enable Software Auto Updates
Update Software.
Disable Software Auto Updates
Change Service Support Plan
Restarts App Stack for service
Get Threshold Alerts for service
Disable Alerts
Enable Alerts.
Change Version of Application Software
Get Firewall Rules
Update Firewall Rules
Disable Firewall
Enable Firewall
SSL Domains List
SSL Domains Add
SSL Domains Remove
SSH public Keys List
Add SSH public keys
Remove SSH public key
Create a snapshot
Get list of Snapshots
Restore a Snapshot
Delete a Snapshot
Disable Snapshot backup
Enable Snapshot backup
Verify S3 Configuration.
Enable Saving Backups to S3.
List Backups saved in S3
Upload backup to S3
Download a backup from S3
Restore a backup saved in S3
Delete a backup saved in S3
Change S3 Backup settings
Update S3 Configuration
Disable S3 Backups
{
  • "action": "reboot",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789"
}

Response samples

Content type
application/json
Example
Reboot Server
Reboot Server
Reset Server
Shutdown Server
Power Down Server
Power Up Server
Get Volumes for the service
Create a new Volume for a service
To Turn On/Off projection for Volume
Resize Volume
Unlink Volume
Delete Service Volume
Activate Termination Protection for Service
Deactivate Termination Protection for Service
Disable Service OS auto updates
Enable Service OS auto updates
Update Server OS
Enable Software Auto Updates
Update Software
Disable Software Auto Updates
Change Service Support Plan
Restarts App Stack for service
Get Threshold Alerts for service
Disable Alerts.
Enable Alerts.
Change Version of Application Software.
Get Firewall Rules.
Update Firewall Rules.
Disable Firewall.
Enable Firewall.
SSL Domains List.
SSL Domains Add.
SSL Domains Remove.
SSH public Keys List.
Add SSH public keys.
Remove SSH public key.
Create a snapshot.
Get list of Snapshots.
Restore a Snapshot.
Delete a Snapshot.
Disable Snapshot backup.
Enable Snapshot backup.
Verify S3 Configuration.
Enable Saving Backups to S3.
List Backups saved in S3.
Upload backup to S3.
Download a backup from S3.
Restore a backup saved in S3.
Delete a backup saved in S3.
Change S3 Backup settings.
Update S3 Configuration.
Disable S3 Backups.
{
  • "actionID": 123456789,
  • "status": "running"
}

Managed local backups

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id of selected server

action
string
Enum: "scriptBackupsList" "scriptBackup" "scriptBackupDelete" "scriptRestore" "..."

Action to be executed

param1
string
param2
string
param3
string

Responses

Request samples

Content type
application/json
Example
List local backups
List local backups
Take a backup
Delete a backup
Restore a backup
{
  • "action": "scriptBackupsList",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "param1": "",
  • "param2": "",
  • "param3": "",
  • "vmID": "123456789"
}

Response samples

Content type
application/json
Example
List local backups
List local backups
Take a local backups
Restore a backup
Restore a backup
{
  • "status": "OK",
  • "data": {
    }
}

Set request limit per IP

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id of selected server

maxRate
string

What should be the maximum rate that needs to be passed

periodType
string

Period Type can be minutes(m), hours(h) ...

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "maxRate": "150",
  • "periodType": "m"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

Set duration for cache

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Service Virtual machine id

durationInSeconds
string

Duration for when get requests should be cached

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "durationInSeconds": "200"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

Get terminal URL & credentials

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id for which user wants a ssh client

projectID
string

Project id of selected service

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "projectID": "123"
}

Response samples

Content type
application/json
{}

Move service from one project to another project

Request Body schema: application/json
jwt
string

User jwt token for Authentication

serviceId
string

Id of service which needs to be moved

projectId
string

Id of project which service should be moved

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "serviceId": "1232323",
  • "projectId": "17734567"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

Get URL for SSHTerminal

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Service Virtual machine ID for getting ssh direct terminal

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789"
}

Response samples

Content type
application/json
{}

Show logs

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Service Virtual machine id for getting logs

mode
string
projectID
string

Selected service project id

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "mode": "mode",
  • "projectID": "123"
}

Response samples

Content type
application/json
{}

Launch VSCode

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Id of virtual machine for starting vs code

projectID
string

If for project

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "projectID": "123"
}

Response samples

Content type
application/json
{}

Launch File Explorer

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Service Virtual machine id for starting file explorer

projectID
string

Selected Service Project id

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "projectID": "123"
}

Response samples

Content type
application/json
{}

Get App URL & Credentials

Get App URL & Credentials in the context of the service.

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Service Virtual machine id

targetPort
string

Port no of application in which it is running

srvPort
string

Service port no

projectID
string

Selected service project id

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "targetPort": "3000",
  • "srvPort": "343",
  • "projectID": "123"
}

Response samples

Content type
application/json
{}

Get Notes

Request Body schema: application/json
jwt
string

User jwt token for Authentication

serverID
string

Server id of the service for getting notes

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "serverID": "34334123"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "OK"
}

Update Notes

Request Body schema: application/json
jwt
string

User jwt token for Authentication

serverID
string

Server id of the Service for updating the notes

notes
string

Notes written by user for service

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "serverID": "12345678",
  • "notes": "notes"
}

Response samples

Content type
application/json
{
  • "message": "Updated successfully",
  • "status": "OK"
}

Get software versions tags

query Parameters
jwt
required
string
Example: jwt=ImF1dGSZQOAINZRpdHNX1dG9S

User Validation token

namespace
required
string
Example: namespace=library

Namespace for service to get docker tags

name
required
string
Example: name=postgres

Name of the service must be provided to get the docker tags

Responses

Request samples 

curl --request GET \
  --url 'https://api.elest.io/api/servers/getDockerTags?jwt=ImF1dGSZQOAINZRpdHNX1dG9S&namespace=library&name=postgres'

Response samples

Content type
application/json
{
  • "status": "OK",
  • "data": [
    ]
}

Get Audits

Request Body schema: application/json
serverIDs
string

Server ids user has access to

jwt
string

User jwt token for Authentication

startDate
string

Starting date when audit is perfomed

endDate
string

End Date for audit

Responses

Request samples

Content type
application/json
{
  • "serverIDs": "[2132,1232]",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "startDate": "11/12/2021",
  • "endDate": "11/12/2021"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "count": 4,
  • "data": [
    ]
}

BACKUPS

Disables Auto Backups

Request Body schema: application/json
jwt
string

User jwt token for Authentication

serverID
string

Server id for service

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "serverID": "34334"
}

Response samples

Content type
application/json
{
  • "message": "Finished",
  • "data": "{\"message\":\"Finished\",\"status\":\"OK\"}",
  • "status": "OK"
}

List remote backups

Request Body schema: application/json
jwt
string

User jwt token for Authentication

serverID
string

Server id of the service

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "serverID": "34334"
}

Response samples

Content type
application/json
{
  • "message": "Finished",
  • "data": [
    ],
  • "status": "OK"
}

Retore remote backup

Request Body schema: application/json
jwt
string

User jwt token for Authentication

serverID
string

Server id of the service which user wants to restore backup

snapshotName
string

Name of the snapshot user wants to restore

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "serverID": "34334",
  • "snapshotName": "backup_34nghnf"
}

Response samples

Content type
application/json
{
  • "message": "Finished",
  • "data": [
    ],
  • "status": "OK"
}

Enable auto backups

Request Body schema: application/json
serverID
string

Server id of the service

backupPath
string

Path where autobackups will be saved

backupHour
string

Every day at this hour a backup will be made

Responses

Request samples

Content type
application/json
{
  • "serverID": "34334",
  • "backupPath": "/backup/",
  • "backupHour": "00:00"
}

Response samples

Content type
application/json
{
  • "message": "Auto Backup Started",
  • "data": {
    },
  • "status": "OK"
}

Crate manual backup

Request Body schema: application/json
jwt
string

User jwt token for Authentication

serverID
string

Server id for service for which backup should be created

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "serverID": "34334"
}

Response samples

Content type
application/json
{}

BILLINGS

Get Billings of user

Request Body schema: application/json
jwt
string

User jwt token for authentication.

projectId
string

Id of project for getting billings

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectId": "17734567"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "data": {
    }
}

Get billings of a project

query Parameters
jwt
required
string
Example: jwt=ImF1dGSZQOAINZRpdHNX1dG9S

User Authentication Token

Responses

Request samples 

curl --request GET \
  --url 'https://api.elest.io/api/billings/getBillings?jwt=ImF1dGSZQOAINZRpdHNX1dG9S'

Response samples

Content type
application/json
{
  • "status": "OK",
  • "data": {
    }
}

PROJECTS

List of projects

Request Body schema: application/json
jwt
string

User jwt token for Authentication

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "data": {
    }
}

Add a new project

Request Body schema: application/json
jwt
string

User jwt token for Authentication

name
string

Name of project to be created

description
string

Project description provided by user

technicalEmails
string

Emails added by user

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "name": "project1",
  • "description": "description",
  • "technicalEmails": "emails"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

Edit project details

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectId
string

Selected service project id

name
string

Name of the project

description
string

Project description

technicalEmails
string

Emails for project

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectId": "17734567",
  • "name": "project1",
  • "description": "description",
  • "technicalEmails": "emails"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

Delete a project

query Parameters
jwt
required
string
Example: jwt=ImF1dGSZQOAINZRpdHNX1dG9S

User Authentication token

projectId
required
string
Example: projectId=17734567

Id of project to be deleted

Responses

Request samples 

curl --request DELETE \
  --url 'https://api.elest.io/api/projects/deleteProject?jwt=ImF1dGSZQOAINZRpdHNX1dG9S&projectId=17734567'

Response samples

Content type
application/json
{
  • "status": "OK"
}

Add a member in a project

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectId
string

Selected project id for adding a member

role
string

Role for member being added

targetEmail
string

Email id of the member

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectId": "17734567",
  • "role": "admin",
  • "targetEmail": "[email protected]"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "Project Member Successfully added",
  • "data": { }
}

Update member role

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectId
string

Selected project id for updating Member

role
string

Role to be modified for member

targetId
string

Member id

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectId": "17734567",
  • "role": "admin",
  • "targetId": "2343"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

Delete a member from a project

query Parameters
jwt
required
string
Example: jwt=ImF1dGSZQOAINZRpdHNX1dG9S

User Validation Token

projectId
required
string
Example: projectId=17734567

Project id user to be deleted

targetId
required
string
Example: targetId=2343

Id of the member for removing from the project

Responses

Request samples 

curl --request DELETE \
  --url 'https://api.elest.io/api/projects/deleteMember?jwt=ImF1dGSZQOAINZRpdHNX1dG9S&projectId=17734567&targetId=2343'

Response samples

Content type
application/json
{
  • "string": "OK"
}

Leave a project

query Parameters
jwt
required
string
Example: jwt=ImF1dGSZQOAINZRpdHNX1dG9S

User Authentication Token

projectId
required
string
Example: projectId=17734567

Id of project which user wants to leave

Responses

Request samples 

curl --request DELETE \
  --url 'https://api.elest.io/api/projects/leaveProject?jwt=ImF1dGSZQOAINZRpdHNX1dG9S&projectId=17734567'

Response samples

Content type
application/json
{
  • "status": "OK"
}

List members project

query Parameters
jwt
required
string
Example: jwt=ImF1dGSZQOAINZRpdHNX1dG9S

User Authentication token

projectId
required
string
Example: projectId=17734567

Project id for getting all members

Responses

Request samples 

curl --request GET \
  --url 'https://api.elest.io/api/projects/getMembersList?jwt=ImF1dGSZQOAINZRpdHNX1dG9S&projectId=17734567'

Response samples

Content type
application/json
{
  • "status": "OK",
  • "data": {
    }
}

USERS

List user public keys

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Selected service project id

action
string

Action to be perform for SSH keys

Responses

Request samples

Content type
application/json
Example
SSHGlobalPubKeysAdd
SSHGlobalPubKeysAdd
SSHGlobalPubKeysList
SSHGlobalPubKeysRemove
{
  • "action": "SSHGlobalPubKeysAdd",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": 123,
  • "name": "key",
  • "key": "dfdlnfdofbdflndf"
}

Response samples

Content type
application/json
Example
SSHGlobalPubKeysAdd
SSHGlobalPubKeysAdd
SSHGlobalPubKeysList
SSHGlobalPubKeysRemove
{
  • "status": "OK"
}

VOLUMES

List volumes

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Selected project Id for getting all volumes

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": "123"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "data": [
    ]
}

List of services which can be attach to the new volume

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Project Id which contains selected volume

volumeID
string

Volume id for get details

isVolumeCreated
string

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": "123",
  • "volumeID": "123",
  • "isVolumeCreated": true
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "data": [
    ]
}

Create a volume

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Project id which has user selected Volume

providerName
string

Provider of the Volume

datacenter
string

Location of datacenter

volumeName
string

Volume Name for creating volume

price
string

The Price of Volume

selectedServerID
string

User Selected Server ID

isMoveData
string

Do user wants to move data of the service to volume

volume
string

SSD volume sizes range from 10 to 1,024 GB, while HDD volumes range from 40 to 1,024 GB.

blockStorageType
string
Enum: "NVME" "HDD"

Only vultr supports both HDD and SSD but only passes one, whereas the others only support SSD.

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": "123",
  • "providerName": "hetzner",
  • "datacenter": "fsnl",
  • "volumeName": "volumeName",
  • "price": "20.0",
  • "selectedServerID": "213",
  • "isMoveData": false,
  • "volume": 10,
  • "blockStorageType": "NVME"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

Take action on a volume

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Selected Service Project Id

action
string
Enum: "manageVolumeProtection" "resizeVolume" "detachVolume" "deleteVolume"

Volume actions User can perform

volumeID
string

Selected Volume Id

Responses

Request samples

Content type
application/json
Example
manageVolumeProtection
manageVolumeProtection
resizeVolume
detachVolume
deleteVolume
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": "123",
  • "action": "manageVolumeProtection",
  • "isVolumeProtection": true,
  • "providerServerID": "123456789",
  • "volumeID": "1245678"
}

Response samples

Content type
application/json
Example
manageVolumeProtection
manageVolumeProtection
resizeVolume
detachVolume
deleteVolume
{
  • "status": "OK",
  • "message": "Volume protection activated successfully"
}

Get volumes count in a project

Request Body schema: application/json
jwt
string

User jwt token for Authentication

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "volumes": 1
}

CICD

Get CICD services

Get existing CICD services for a project

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Project id for the selected service

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": "17734567"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create new CICD pipeline

Creates a new CICD pipeline in the selected existing CICD service

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Project id for the selected service

CICDMode
string

Type of social provider like Github,Gitlab and Docker

ports
array

Proxy-ports for CICD pipeline

variables
string

Environment variables

cluster
object

Details of selected CICD service

configData
object

Configuration details for the pipeline

gitData
object

Details of the repository

exposedPorts
array

Exposedports for CICD pipeline

gitVolumeConfig
array

Volume configuration of the pipeline

isNeedToCreateRepo
boolean

To check whether the user needs to create repository or not

gitUserFormData
object

Details for creating a new repository

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": "17734567",
  • "CICDMode": "GITHUB",
  • "ports": [
    ],
  • "variables": "ENV=production\n",
  • "cluster": {
    },
  • "configData": {
    },
  • "gitData": {},
  • "exposedPorts": [
    ],
  • "gitVolumeConfig": [
    ],
  • "isNeedToCreateRepo": false,
  • "gitUserFormData": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "CI/CD Pipeline created successfully",
  • "providerServerID": "21540524",
  • "serviceName": "cicd-5crnj"
}

Get the details of the deployed service pipelines

Get the details of the deployed service pipelines

Request Body schema: application/json
projectID
string

Project id for the selected service

jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id of selected service

Responses

Request samples

Content type
application/json
{
  • "projectID": "17734567",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": [
    ]
}

Get actions done on pipeline

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id of selected service

projectID
string

Project id for the selected service

pipelineID
string

Pipeline id of the selected pipeline

action
string
Enum: "reSyncPipeline" "deletePipeline" "restartAppStack" "pipelineRunningLogs" "getHistory" "updateBuildConfig" "SSLDomainsList" "SSLDomainsAdd" "SSLDomainsRemove" "stopAppStack" "moveExistTargetPipeline"

Action to be executed

Responses

Request samples

Content type
application/json
Example
reSyncPipeline
reSyncPipeline
deletePipeline
restartAppStack
pipelineRunningLogs
getHistory
updateBuildConfig
SSLDomainsList
SSLDomainsAdd
SSLDomainsRemove
stopAppStack
moveExistTargetPipeline
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "21570146",
  • "projectID": "94",
  • "pipelineID": 362
}

Response samples

Content type
application/json
{
  • "reSyncPipeline": {
    },
  • "deletePipeline": {
    },
  • "restartAppStack": {},
  • "pipelineRunningLogs": {},
  • "getHistory": {
    },
  • "updateBuildConfig": {
    },
  • "SSLDomainsList": {
    },
  • "SSLDomainsAdd": {
    },
  • "SSLDomainsRemove": {
    },
  • "stopAppStack": {},
  • "moveExistTargetPipeline": {
    }
}

Get the details of the deployed pipeline

Get the details of the deployed pipeline

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id of selected service

projectID
string

Project id for the selected service

pipelineID
number

Pipeline id of the selected pipeline

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "projectID": "17734567",
  • "pipelineID": 83839200
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": [
    ]
}

Get the list of deployed pipelines

Get the list of deployed pipelines

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Project id for the selected service

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": "17734567"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • "..."
]

Get details of the project pipelines

Get details of the project pipelines

Request Body schema: application/json
projectID
string

Project id for the selected service

jwt
string

User jwt token for Authentication

Responses

Request samples

Content type
application/json
{
  • "projectID": "17734567",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": [
    ]
}

Get details of the project pipelines

Get details of the project pipelines

Request Body schema: application/json
jwt
string

User jwt token for Authentication

vmID
string

Virtual machine id of selected service

projectID
string

Project id for the selected service

pipelineID
string

Pipeline id of the selected pipeline

filepath
string

Name of the log file

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "vmID": "123456789",
  • "projectID": "17734567",
  • "pipelineID": 83839200,
  • "filepath": "2022-06-23-12.42.01.log"
}

Response samples

Content type
application/json
{}

Add Docker login credentials

Request Body schema: application/json
identityName
string

Identity for login

jwt
string

User jwt token for Authentication

password
string

Password/Access_Token for Docker account

projectID
string

Project id for the selected service

url
string

Docker repository

username
string

Docker user name

Responses

Request samples

Content type
application/json
{
  • "identityName": "repositoryLogin",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "password": "******",
  • "projectID": "17734567",
  • "url": "username/repository",
  • "username": "john123"
}

Response samples

Content type
application/json
{
  • "identityName": "john123",
  • "login": "userName",
  • "registryURL": "userName/gridsome"
}

Validate Docker login credentials

Request Body schema: application/json
identityName
string

Identity for login

password
string

Password/Access_Token for Docker account

repo
string

Docker repository

username
string

Docker user name

Responses

Request samples

Content type
application/json
{
  • "identityName": "repositoryLogin",
  • "password": "******",
  • "repo": "repository",
  • "username": "john123"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Fetch Docker login credentials

Request Body schema: application/json
jwt
string

User jwt token for Authentication

projectID
string

Project id for the selected service

Responses

Request samples

Content type
application/json
{
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
  • "projectID": "17734567"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Domains

List domains

List domains

Request Body schema: application/json
projectID
string

Project id for the selected project

jwt
string

User jwt token for Authentication

Responses

Request samples

Content type
application/json
{
  • "projectID": "17734567",
  • "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": [
    ]
}