Endpoints

get

get all pending/done job list

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/accounts/jobs/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get detail for a specific job

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
uuidstring · uuidRequerido
Respuestas
200

ok/error

application/json
get
GET /api/accounts/job/?account=text&uuid=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get single account info

Autorizaciones
Parámetros de consulta
accountstring · accountOpcional
Respuestas
200

ok/error

application/json
get
GET /api/account/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get projects for an account

Autorizaciones
Parámetros de consulta
accountstring · accountOpcional
Respuestas
200

ok/error

application/json
get
GET /api/projects/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
patch

update project info

Autorizaciones
Cuerpo
uuidstring · uuidRequerido
namestringOpcional
sshPasswordstringOpcional
ftpPasswordstringOpcional
Respuestas
200

ok/error

application/json
patch
PATCH /api/projects/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "sshPassword": "text",
  "ftpPassword": "text"
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get sso accounts

Autorizaciones
Parámetros de consulta
accountstring · accountOpcional
Respuestas
200

ok/error

application/json
get
GET /api/accounts/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
patch

update account settings, limits, status

Autorizaciones
Cuerpo
accountstring · accountRequerido
enabledbooleanOpcional
deletebooleanOpcional
namestringOpcionalPattern: /^[\p{IsAlnum}\p{IsPunct}\p{IsSpace}]{1,64}$/u
Respuestas
200

ok/error

application/json
patch
PATCH /api/accounts/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "account": "text",
  "enabled": true,
  "delete": true,
  "name": "text"
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get dashboard for all projects in the account

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/accounts/dashboard/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get status of backup jobs

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/accounts/backups/jobs/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
post

queue new Backup Restore Job

Autorizaciones
Cuerpo
objectOpcional
Respuestas
200

ok/error

application/json
post
POST /api/accounts/backups/restore/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get backup list

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
frequencyinteger · mín: 1 · máx: 24Opcional
Respuestas
200

ok/error

application/json
get
GET /api/accounts/backups/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

browse backup contents

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
datestringRequerido
pathstringOpcional
Respuestas
200

ok/error

application/json
get
GET /api/accounts/backups/browse/?account=text&date=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

download backed up file

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
datestringRequerido
pathstringOpcional
Respuestas
200

ok/error

application/json
get
GET /api/accounts/backups/download/?account=text&date=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get db backup list

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/mysql/backups/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get db table backup list

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
dbstring · slugRequerido
datestring · slugRequerido
Respuestas
200

ok/error

application/json
get
GET /api/mysql/backups/tables/?account=text&db=text&date=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

download backed up mysql database

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
datestringRequeridoPattern: ^\d{10}$
dbstringRequerido
Respuestas
200

ok/error

application/json
get
GET /api/mysql/backups/downloadDb/?account=text&date=text&db=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

download backed up mysql table

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
datestringRequeridoPattern: ^\d{10}$
dbstringRequerido
tablestringRequerido
Respuestas
200

ok/error

application/json
get
GET /api/mysql/backups/downloadTable/?account=text&date=text&db=text&table=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
patch

update mail server in/active status and master mail server for a domain

Autorizaciones
Cuerpo
accountstring · accountRequerido
domainstring · hostRequerido
isActivebooleanOpcional
isMainbooleanOpcional
Respuestas
200

ok/error

application/json
patch
PATCH /api/emails/mailServer/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "account": "text",
  "domain": "text",
  "isActive": true,
  "isMain": true
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get importer status

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/emails/syncIMAP/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
post

queue new e-mail importer job

Autorizaciones
Cuerpo
objectOpcional
Respuestas
200

ok/error

application/json
post
POST /api/emails/syncIMAP/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

test imap login credentiales

Autorizaciones
Parámetros de consulta
usernamestringRequerido
passwordstringRequerido
hoststringRequerido
Respuestas
200

ok/error

application/json
get
GET /api/emails/testIMAP/?username=text&password=text&host=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get account email service info

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/emails/dashboard/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get account cloudsmtp info

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/emails/cloudsmtp/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get account sites info

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/sites/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
patch

update site config

Autorizaciones
Cuerpo
objectOpcional
Respuestas
200

ok/error

application/json
patch
PATCH /api/sites/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get list of available reports

Autorizaciones
Parámetros de consulta
sitestring · siteRequerido
Respuestas
200

ok/error

application/json
get
GET /api/sites/analyticsReports?site=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get single report

Autorizaciones
Parámetros de consulta
sitestring · siteRequerido
reportstringRequeridoPattern: ^\d{4}-\d{2}$
Respuestas
200

ok/error

application/json
get
GET /api/sites/analyticsReport?site=text&report=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get a list of WHMCS products linked to this account

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/products/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get account invoices from WHMCS

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/invoices/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get individual invoice from WHMCS

Autorizaciones
Parámetros de ruta
invoiceintegerRequerido
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/invoices/{invoice}/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get individual invoice from WHMCS

Autorizaciones
Parámetros de ruta
invoiceintegerRequerido
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/invoices/{invoice}.pdf?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get WHMCS logged in redirect URL for sso+account combination

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
goToURLstringRequerido
Respuestas
200

ok/error

application/json
get
GET /api/whmcs/redirectTo?account=text&goToURL=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get last Lighhouse report list

Autorizaciones
Parámetros de consulta
sitestring · siteRequerido
Respuestas
200

ok/error

application/json
get
GET /api/sites/lightHouse?site=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get last Lighhouse running jobs

Autorizaciones
Parámetros de consulta
sitestring · siteRequerido
Respuestas
200

ok/error

application/json
get
GET /api/sites/lightHouse/jobs?site=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

get last Lighhouse report

Autorizaciones
Parámetros de consulta
sitestring · siteRequerido
htmlinteger · máx: 1Opcional
reportstring · uuidOpcional
Respuestas
200

ok/error

application/json
get
GET /api/sites/lightHouse/report?site=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
post

queue new Lighhouse report

Autorizaciones
Cuerpo
objectOpcional
Respuestas
200

ok/error

application/json
post
POST /api/sites/lightHouse/report HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

resets default subdomains & dns records

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
domainstring · hostRequerido
Respuestas
200

ok/error

application/json
get
GET /api/domains/reset/?account=text&domain=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

returns DNS Domain info

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
Respuestas
200

ok/error

application/json
get
GET /api/domains/?account=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
post

create a new Domain name for the account

Autorizaciones
Cuerpo
accountstringOpcional
domainstringOpcional
Respuestas
200

ok/error

application/json
post
POST /api/domains/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "account": "text",
  "domain": "text"
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
delete

delete Domain name for the account

Autorizaciones
Cuerpo
accountstringOpcional
domainstring · siteOpcional
Respuestas
200

ok/error

application/json
delete
DELETE /api/domains/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "account": "text",
  "domain": "text"
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

refresh dns delegation, a and acme info for domain

Autorizaciones
Parámetros de consulta
accountstring · accountRequerido
domainstring · siteRequerido
Respuestas
200

ok/error

application/json
get
GET /api/dns/delegation/?account=text&domain=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
post

emit or renew SSL cert for domain

Autorizaciones
Cuerpo
accountstringOpcional
domainstringOpcional
Respuestas
200

ok/error

application/json
post
POST /api/domains/ssl/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "account": "text",
  "domain": "text"
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
delete

revoke SSL certificate

Autorizaciones
Cuerpo
accountstringOpcional
domainstring · siteOpcional
Respuestas
200

ok/error

application/json
delete
DELETE /api/domains/ssl/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "account": "text",
  "domain": "text"
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
patch

update RR content

Autorizaciones
Parámetros de consulta
domainstring · siteRequerido
uuidstring · uuidRequerido
Cuerpo
typestringOpcionalPattern: ^A|AAAA|CNAME|TXT|SPF|MX|SRV$
datastringOpcional
ttlinteger · máx: 31536000Opcional
Respuestas
200

ok/error

application/json
patch
PATCH /api/domains/dns/?domain=text&uuid=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "type": "text",
  "data": "text",
  "ttl": 1
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

returns social network login connections

Autorizaciones
Respuestas
200

login connections list

application/json
get
GET /api/users/connections/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

login connections list

{
  "message": "text",
  "status": "text"
}
get

returns logged in user sessions

Autorizaciones
Respuestas
200

session list

application/json
get
GET /api/users/sessions/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

session list

{
  "message": "text",
  "status": "text"
}
delete

delete a session token

Autorizaciones
Parámetros de consulta
tokenstringRequerido
Respuestas
200

ok/error

application/json
delete
DELETE /api/users/sessions/?token=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

returns logged in user information

Autorizaciones
Respuestas
200

user info

application/json
get
GET /api/users/me/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

user info

{
  "email": "[email protected]",
  "name": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "text",
  "createdAt": "text",
  "bio": "text",
  "slug": "text"
}
patch
Autorizaciones
Cuerpo
emailstring · emailOpcional
biostringOpcional
slugstring · slugOpcional
namestringOpcional
Respuestas
200

only patched info objects

application/json
patch
PATCH /api/users/me/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "email": "[email protected]",
  "bio": "text",
  "slug": "text",
  "name": "text"
}
200

only patched info objects

{
  "email": "[email protected]",
  "name": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "text",
  "createdAt": "text",
  "bio": "text",
  "slug": "text"
}
get

Generate a session token for an existing user via a OTP sent by mail.

Parámetros de consulta
emailstring · emailOpcional
otpstring · jwtOpcional

JWT encoded one time password

passwordstringOpcional

a plain password

redirectUrlstringOpcional

Url to redirect user after successful auth

Respuestas
200

ok/error

application/json
get
GET /api/users/signin/ HTTP/1.1
Host: 
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
post

Create a new user via e-mail. Must be logged out to do so.

Autorizaciones
Cuerpo
emailstring · emailRequerido
Respuestas
200

ok/error

application/json
post
POST /api/users/ HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

ends user session and token

Respuestas
200

ok/error

application/json
get
GET /api/users/signout/ HTTP/1.1
Host: 
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

login user through connected github account

Autorizaciones
Respuestas
200

ok/error

application/json
get
GET /api/users/github/signin HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

auth,connect logged in user to github account

Autorizaciones
Parámetros de consulta
codestringOpcional

code from OAuth2 server

Respuestas
200

ok/error

application/json
get
GET /api/users/github/connect HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

disconnect logged in user from github account

Autorizaciones
Respuestas
200

ok/error

application/json
get
GET /api/users/github/disconnect HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

login user through connected google account

Autorizaciones
Respuestas
200

ok/error

application/json
get
GET /api/users/google/signin HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

auth,connect logged in user to google account

Autorizaciones
Parámetros de consulta
codestringOpcional

code from OAuth2 server

Respuestas
200

ok/error

application/json
get
GET /api/users/google/connect HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

disconnect logged in user from google account

Autorizaciones
Respuestas
200

ok/error

application/json
get
GET /api/users/google/disconnect HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

returns github repositories of a user

Autorizaciones
Respuestas
200

ok/error

application/json
get
GET /api/github/repos HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
get

returns github branches of a repository

Autorizaciones
Parámetros de consulta
repositorystringRequerido
Respuestas
200

ok/error

application/json
get
GET /api/github/repo/branches?repository=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

ok/error

{
  "message": "text",
  "status": "text"
}
AnteriorPlayGroundSiguienteROADMAP (próximamente)

Última actualización