Endpoints

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/jobs/

get all pending/done job list

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/accounts/jobs/

HTTPcURLJavaScriptPython

GET /api/accounts/jobs/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/job/

get detail for a specific job

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

uuidstring · uuidRequerido

Respuestas

200

ok/error

application/json

get

/accounts/job/

HTTPcURLJavaScriptPython

GET /api/accounts/job/?account=text&uuid=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/account/

get single account info

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountOpcional

Respuestas

200

ok/error

application/json

get

/account/

HTTPcURLJavaScriptPython

GET /api/account/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/projects/

get projects for an account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountOpcional

Respuestas

200

ok/error

application/json

get

/projects/

HTTPcURLJavaScriptPython

GET /api/projects/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

patch

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/projects/

update project info

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

uuidstring · uuidRequerido

namestringOpcional

sshPasswordstringOpcional

ftpPasswordstringOpcional

Respuestas

200

ok/error

application/json

patch

/projects/

HTTPcURLJavaScriptPython

PATCH /api/projects/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/

get sso accounts

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountOpcional

Respuestas

200

ok/error

application/json

get

/accounts/

HTTPcURLJavaScriptPython

GET /api/accounts/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

patch

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/

update account settings, limits, status

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

accountstring · accountRequerido

enabledbooleanOpcional

deletebooleanOpcional

namestringOpcionalPattern: /^[\p{IsAlnum}\p{IsPunct}\p{IsSpace}]{1,64}$/u

Respuestas

200

ok/error

application/json

patch

/accounts/

HTTPcURLJavaScriptPython

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

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

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/dashboard/

get dashboard for all projects in the account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/accounts/dashboard/

HTTPcURLJavaScriptPython

GET /api/accounts/dashboard/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/backups/jobs/

get status of backup jobs

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/accounts/backups/jobs/

HTTPcURLJavaScriptPython

GET /api/accounts/backups/jobs/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

post

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/backups/restore/

queue new Backup Restore Job

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

objectOpcional

Respuestas

200

ok/error

application/json

post

/accounts/backups/restore/

HTTPcURLJavaScriptPython

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

{}

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/backups/

get backup list

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

frequencyinteger · mín: 1 · máx: 24Opcional

Respuestas

200

ok/error

application/json

get

/accounts/backups/

HTTPcURLJavaScriptPython

GET /api/accounts/backups/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/backups/browse/

browse backup contents

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

datestringRequerido

pathstringOpcional

Respuestas

200

ok/error

application/json

get

/accounts/backups/browse/

HTTPcURLJavaScriptPython

GET /api/accounts/backups/browse/?account=text&date=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/accounts/backups/download/

download backed up file

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

datestringRequerido

pathstringOpcional

Respuestas

200

ok/error

application/json

get

/accounts/backups/download/

HTTPcURLJavaScriptPython

GET /api/accounts/backups/download/?account=text&date=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/mysql/backups/

get db backup list

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/mysql/backups/

HTTPcURLJavaScriptPython

GET /api/mysql/backups/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/mysql/backups/tables/

get db table backup list

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

dbstring · slugRequerido

datestring · slugRequerido

Respuestas

200

ok/error

application/json

get

/mysql/backups/tables/

HTTPcURLJavaScriptPython

GET /api/mysql/backups/tables/?account=text&db=text&date=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/mysql/backups/downloadDb/

download backed up mysql database

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

datestringRequeridoPattern: ^\d{10}$

dbstringRequerido

Respuestas

200

ok/error

application/json

get

/mysql/backups/downloadDb/

HTTPcURLJavaScriptPython

GET /api/mysql/backups/downloadDb/?account=text&date=text&db=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/mysql/backups/downloadTable/

download backed up mysql table

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

datestringRequeridoPattern: ^\d{10}$

dbstringRequerido

tablestringRequerido

Respuestas

200

ok/error

application/json

get

/mysql/backups/downloadTable/

HTTPcURLJavaScriptPython

GET /api/mysql/backups/downloadTable/?account=text&date=text&db=text&table=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

patch

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/emails/mailServer/

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

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

accountstring · accountRequerido

domainstring · hostRequerido

isActivebooleanOpcional

isMainbooleanOpcional

Respuestas

200

ok/error

application/json

patch

/emails/mailServer/

HTTPcURLJavaScriptPython

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

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

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/emails/syncIMAP/

get importer status

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/emails/syncIMAP/

HTTPcURLJavaScriptPython

GET /api/emails/syncIMAP/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

post

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/emails/syncIMAP/

queue new e-mail importer job

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

objectOpcional

Respuestas

200

ok/error

application/json

post

/emails/syncIMAP/

HTTPcURLJavaScriptPython

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

{}

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/emails/testIMAP/

test imap login credentiales

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

usernamestringRequerido

passwordstringRequerido

hoststringRequerido

Respuestas

200

ok/error

application/json

get

/emails/testIMAP/

HTTPcURLJavaScriptPython

GET /api/emails/testIMAP/?username=text&password=text&host=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/emails/dashboard/

get account email service info

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/emails/dashboard/

HTTPcURLJavaScriptPython

GET /api/emails/dashboard/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/emails/cloudsmtp/

get account cloudsmtp info

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/emails/cloudsmtp/

HTTPcURLJavaScriptPython

GET /api/emails/cloudsmtp/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/sites/

get account sites info

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/sites/

HTTPcURLJavaScriptPython

GET /api/sites/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

patch

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/sites/

update site config

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

objectOpcional

Respuestas

200

ok/error

application/json

patch

/sites/

HTTPcURLJavaScriptPython

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

{}

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/sites/analyticsReports

get list of available reports

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

sitestring · siteRequerido

Respuestas

200

ok/error

application/json

get

/sites/analyticsReports

HTTPcURLJavaScriptPython

GET /api/sites/analyticsReports?site=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/sites/analyticsReport

get single report

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

sitestring · siteRequerido

reportstringRequeridoPattern: ^\d{4}-\d{2}$

Respuestas

200

ok/error

application/json

get

/sites/analyticsReport

HTTPcURLJavaScriptPython

GET /api/sites/analyticsReport?site=text&report=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/products/

get a list of WHMCS products linked to this account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/products/

HTTPcURLJavaScriptPython

GET /api/products/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/invoices/

get account invoices from WHMCS

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/invoices/

HTTPcURLJavaScriptPython

GET /api/invoices/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/invoices/{invoice}/

get individual invoice from WHMCS

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de ruta

invoiceintegerRequerido

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/invoices/{invoice}/

HTTPcURLJavaScriptPython

GET /api/invoices/{invoice}/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/invoices/{invoice}.pdf

get individual invoice from WHMCS

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de ruta

invoiceintegerRequerido

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/invoices/{invoice}.pdf

HTTPcURLJavaScriptPython

GET /api/invoices/{invoice}.pdf?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/whmcs/redirectTo

get WHMCS logged in redirect URL for sso+account combination

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

goToURLstringRequerido

Respuestas

200

ok/error

application/json

get

/whmcs/redirectTo

HTTPcURLJavaScriptPython

GET /api/whmcs/redirectTo?account=text&goToURL=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/sites/lightHouse

get last Lighhouse report list

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

sitestring · siteRequerido

Respuestas

200

ok/error

application/json

get

/sites/lightHouse

HTTPcURLJavaScriptPython

GET /api/sites/lightHouse?site=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/sites/lightHouse/jobs

get last Lighhouse running jobs

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

sitestring · siteRequerido

Respuestas

200

ok/error

application/json

get

/sites/lightHouse/jobs

HTTPcURLJavaScriptPython

GET /api/sites/lightHouse/jobs?site=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/sites/lightHouse/report

get last Lighhouse report

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

sitestring · siteRequerido

htmlinteger · máx: 1Opcional

reportstring · uuidOpcional

Respuestas

200

ok/error

application/json

get

/sites/lightHouse/report

HTTPcURLJavaScriptPython

GET /api/sites/lightHouse/report?site=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

post

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/sites/lightHouse/report

queue new Lighhouse report

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

objectOpcional

Respuestas

200

ok/error

application/json

post

/sites/lightHouse/report

HTTPcURLJavaScriptPython

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

{}

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/domains/reset/

resets default subdomains & dns records

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

domainstring · hostRequerido

Respuestas

200

ok/error

application/json

get

/domains/reset/

HTTPcURLJavaScriptPython

GET /api/domains/reset/?account=text&domain=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/domains/

returns DNS Domain info

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

Respuestas

200

ok/error

application/json

get

/domains/

HTTPcURLJavaScriptPython

GET /api/domains/?account=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

post

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/domains/

create a new Domain name for the account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

accountstringOpcional

domainstringOpcional

Respuestas

200

ok/error

application/json

post

/domains/

HTTPcURLJavaScriptPython

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

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

200

ok/error

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

delete

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/domains/

delete Domain name for the account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

accountstringOpcional

domainstring · siteOpcional

Respuestas

200

ok/error

application/json

delete

/domains/

HTTPcURLJavaScriptPython

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

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

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/dns/delegation/

refresh dns delegation, a and acme info for domain

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

accountstring · accountRequerido

domainstring · siteRequerido

Respuestas

200

ok/error

application/json

get

/dns/delegation/

HTTPcURLJavaScriptPython

GET /api/dns/delegation/?account=text&domain=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

post

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/domains/ssl/

emit or renew SSL cert for domain

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

accountstringOpcional

domainstringOpcional

Respuestas

200

ok/error

application/json

post

/domains/ssl/

HTTPcURLJavaScriptPython

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

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

200

ok/error

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

delete

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/domains/ssl/

revoke SSL certificate

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

accountstringOpcional

domainstring · siteOpcional

Respuestas

200

ok/error

application/json

delete

/domains/ssl/

HTTPcURLJavaScriptPython

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

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

200

ok/error

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

patch

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/domains/dns/

update RR content

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

domainstring · siteRequerido

uuidstring · uuidRequerido

Cuerpo

application/json

typestringOpcionalPattern: ^A|AAAA|CNAME|TXT|SPF|MX|SRV$

datastringOpcional

ttlinteger · máx: 31536000Opcional

Respuestas

200

ok/error

application/json

patch

/domains/dns/

HTTPcURLJavaScriptPython

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

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

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/connections/

returns social network login connections

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Respuestas

200

login connections list

application/json

get

/users/connections/

HTTPcURLJavaScriptPython

GET /api/users/connections/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

login connections list

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/sessions/

returns logged in user sessions

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Respuestas

200

session list

application/json

get

/users/sessions/

HTTPcURLJavaScriptPython

GET /api/users/sessions/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

session list

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

delete

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/sessions/

delete a session token

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

tokenstringRequerido

Respuestas

200

ok/error

application/json

delete

/users/sessions/

HTTPcURLJavaScriptPython

DELETE /api/users/sessions/?token=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/me/

returns logged in user information

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Respuestas

200

user info

application/json

get

/users/me/

HTTPcURLJavaScriptPython

GET /api/users/me/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

user info

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

patch

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/me/

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

emailstring · emailOpcional

biostringOpcional

slugstring · slugOpcional

namestringOpcional

Respuestas

200

only patched info objects

application/json

patch

/users/me/

HTTPcURLJavaScriptPython

PATCH /api/users/me/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/signin/

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

/users/signin/

HTTPcURLJavaScriptPython

GET /api/users/signin/ HTTP/1.1
Accept: */*

200

ok/error

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

post

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/

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

Autorizaciones

mustBeLoggedOut

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

emailstring · emailRequerido

Respuestas

200

ok/error

application/json

post

/users/

HTTPcURLJavaScriptPython

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

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

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/signout/

ends user session and token

Respuestas

200

ok/error

application/json

get

/users/signout/

HTTPcURLJavaScriptPython

GET /api/users/signout/ HTTP/1.1
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/github/signin

login user through connected github account

Autorizaciones

mustBeLoggedOut

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Respuestas

200

ok/error

application/json

get

/users/github/signin

HTTPcURLJavaScriptPython

GET /api/users/github/signin HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/github/connect

auth,connect logged in user to github account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

codestringOpcional

code from OAuth2 server

Respuestas

200

ok/error

application/json

get

/users/github/connect

HTTPcURLJavaScriptPython

GET /api/users/github/connect HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/github/disconnect

disconnect logged in user from github account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Respuestas

200

ok/error

application/json

get

/users/github/disconnect

HTTPcURLJavaScriptPython

GET /api/users/github/disconnect HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/google/signin

login user through connected google account

Autorizaciones

mustBeLoggedOut

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Respuestas

200

ok/error

application/json

get

/users/google/signin

HTTPcURLJavaScriptPython

GET /api/users/google/signin HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/google/connect

auth,connect logged in user to google account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

codestringOpcional

code from OAuth2 server

Respuestas

200

ok/error

application/json

get

/users/google/connect

HTTPcURLJavaScriptPython

GET /api/users/google/connect HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/users/google/disconnect

disconnect logged in user from google account

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Respuestas

200

ok/error

application/json

get

/users/google/disconnect

HTTPcURLJavaScriptPython

GET /api/users/google/disconnect HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/github/repos

returns github repositories of a user

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Respuestas

200

ok/error

application/json

get

/github/repos

HTTPcURLJavaScriptPython

GET /api/github/repos HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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

get

/apihttps://devapi.latincloud.com:{port}/{basePath}https://codeapi.latincloud.com:{port}/{basePath}

/github/repo/branches

returns github branches of a repository

Autorizaciones

mustBeLoggedIn

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de consulta

repositorystringRequerido

Respuestas

200

ok/error

application/json

get

/github/repo/branches

HTTPcURLJavaScriptPython

GET /api/github/repo/branches?repository=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

ok/error

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