View Source Radixir.System.API (radixir v0.0.3)
Submits requests to System API.
Link to this section Summary
Functions
Submits request to /system/addressbook
.
Submits request to /system/configuration
.
Submits request to /system/health
.
Submits request to /system/metrics
.
Submits request to /system/peers
.
Submits request to /prometheus/metrics
.
Submits request to /system/version
.
Link to this section Types
Specs
options() :: keyword()
Link to this section Functions
Specs
Submits request to /system/addressbook
.
Parameters
options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
System API Documentation
Specs
Submits request to /system/configuration
.
Parameters
options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
System API Documentation
Specs
Submits request to /system/health
.
Parameters
options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
System API Documentation
Specs
Submits request to /system/metrics
.
Parameters
options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
System API Documentation
Specs
Submits request to /system/peers
.
Parameters
options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
System API Documentation
Specs
Submits request to /prometheus/metrics
.
Parameters
options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
System API Documentation
Specs
Submits request to /system/version
.
Parameters
options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.