Documentation Powered by ReDoc

Infinite Proxy (1.0.0)

Download OpenAPI specification:Download

E-mail: support@realfusio.com License: Close Source

Infinite Proxy api

Authentication

Basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Bearer

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Infinite_Data_Api_Key

an api key allowing 'admin' access on a proxy

Security Scheme Type API Key
Header parameter name: x-infinite-apikey

Infinite_Data_Session

a data session bearer

Security Scheme Type API Key
Header parameter name: x-infinite-bearer

Infinite_Directory_Admin

a directory session bearer with access rights to the frontend

Security Scheme Type API Key
Header parameter name: x-infinite-bearer

Infinite_Directory_Session

a directory session bearer

Security Scheme Type API Key
Header parameter name: x-infinite-bearer

/getversion

gets the version of the API

query Parameters
status
boolean
Default: false

checks and returns the status of the directory in the 'status' field

html
boolean
Default: false

returns an html page instead of json

Responses

Response samples

Content type
application/json; charset=utf-8
application/json; charset=utf-8
text/html; charset=utf-8
{
  • "comment": "string",
  • "status": "green",
  • "timebase": "string",
  • "type": "proxyapi",
  • "version": {
    }
}

/getversionprotected

same as getversion but with credentials

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_SessionInfinite_Data_Session
query Parameters
status
boolean
Default: false

checks and returns the status of the directory in the 'status' field

html
boolean
Default: false

returns an html page instead of json

Responses

Response samples

Content type
application/json; charset=utf-8
application/json; charset=utf-8
text/html; charset=utf-8
{
  • "comment": "string",
  • "status": "green",
  • "timebase": "string",
  • "type": "proxyapi",
  • "version": {
    }
}

/manage/build/{buildid}

Removes this build from a static proxy or triggers a resync for dynamic proxy

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
buildid
required
string 38 characters ^\{[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-...

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/manage/cleanup

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
query Parameters
type
string
Default: "sync"
Enum: "sync" "full"


sync : will only update states and look for replication tasks
full : will also remove unnecessary data

reason
string <= 64 characters

an information string that will be logged

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/manage/restoreBuild

upload an evojuump

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
query Parameters
evojuumppassword
required
string
Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}