Documentation Powered by ReDoc

Infinite Directory manage (1.0.0)

Download OpenAPI specification:Download

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

The API allows to access the proxies collection.

Authentication

Basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Bearer

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

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_Api_Key

an api key allowing 'admin' access on the directory

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

/

list proxies

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8

Non documented. Do not use.

Array of objects

a list of filter objects or compound filters

limit
integer
offset
integer
operator
string
Enum: "AND" "OR"
resultfields
Array of strings

list of fields to retrieve (if implemented), if empty all fields are returned

object

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "filters": [
    ],
  • "limit": 100,
  • "offset": 200,
  • "operator": "AND",
  • "resultfields": [
    ],
  • "sort": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 2,
  • "data": [
    ]
}

/{proxylabel}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
proxylabel
required
string non-empty ^[^\/\\]*$
Example: MyGenerator

the name of an ∞Server

Responses

Response samples

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

/{proxylabel}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
proxylabel
required
string non-empty ^[^\/\\]*$
Example: MyGenerator

the name of an ∞Server

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "acceptnewconnections": true,
  • "activeconnections": 138,
  • "alternativeurls": {
    },
  • "clientmessage": {
    },
  • "haserror": false,
  • "label": "MyGenerator",
  • "login": "string",
  • "nodeinfo": { },
  • "portpg": 0,
  • "tags": [
    ],
  • "url": "string"
}

/{proxylabel}

Edit a registered proxy

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
proxylabel
required
string non-empty ^[^\/\\]*$
Example: MyGenerator

the name of an ∞Server

header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8
acceptnewconnections
boolean
object

a map containing only urls

object or object
label
string
tags
Array of strings

tag list

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "acceptnewconnections": true,
  • "alternativeurls": {
    },
  • "clientmessage": {
    },
  • "label": "string",
  • "tags": [
    ]
}

Response samples

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

/{proxylabel}/revokeusers

Revokes immediatly all data sessions associated to this proxy

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
proxylabel
required
string non-empty ^[^\/\\]*$
Example: MyGenerator

the name of an ∞Server

Responses

Response samples

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

/{proxylabel}/sources

list proxy sources

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
proxylabel
required
string non-empty ^[^\/\\]*$
Example: MyGenerator

the name of an ∞Server

header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8

Non documented. Do not use.

Array of objects

a list of filter objects or compound filters

limit
integer
offset
integer
operator
string
Enum: "AND" "OR"
resultfields
Array of strings

list of fields to retrieve (if implemented), if empty all fields are returned

object

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "filters": [
    ],
  • "limit": 100,
  • "offset": 200,
  • "operator": "AND",
  • "resultfields": [
    ],
  • "sort": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 2,
  • "data": [
    ]
}

/{proxylabel}/sources/{proxysourceuuid}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
proxylabel
required
string non-empty ^[^\/\\]*$
Example: MyGenerator

the name of an ∞Server

proxysourceuuid
required
string non-empty

the uuid of a proxy source

Responses

Response samples

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

/{proxylabel}/sources/{proxysourceuuid}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
proxylabel
required
string non-empty ^[^\/\\]*$
Example: MyGenerator

the name of an ∞Server

proxysourceuuid
required
string non-empty

the uuid of a proxy source

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "labeldest": "string",
  • "labelsrc": "string",
  • "sourcedescriptor": "string",
  • "tags": [
    ]
}

/{proxylabel}/sources/{proxysourceuuid}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
proxylabel
required
string non-empty ^[^\/\\]*$
Example: MyGenerator

the name of an ∞Server

proxysourceuuid
required
string non-empty

the uuid of a proxy source

header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8
proxysrclabel
required
string non-empty ^[^\/\\]*$

the name of an ∞Server

tags
required
Array of strings

tag list

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "proxysrclabel": "MyGenerator",
  • "tags": [
    ]
}

Response samples

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