System Service (2.3.0)

Download OpenAPI specification:Download

This is the spec that defines the API provided by the application to validate authorization for the passed role

SupportSave

getSupport

Capture the supportsave data and return the file name in the response

Responses

Backup

getBackup

Backup all EFA configurations

Responses

Restore

getRestore

Restore all EFA configurations

query Parameters
tar_name
required
string

Provide backup tar or directory name [Note: Backup tar or directory must be at /var/log/efa/backup]

Responses

Feature Setting

getFeatureSettingList

Responses

updateFeatureSetting

Request Body schema: application/json

Update Feature Settings.

required
Array of objects (FeatureParameter)

Responses

Request samples

Content type
application/json
{
  • "keyval":
    [
    ]
}

System Setting

getSystemSetting

Responses

updateSystemSetting

Request Body schema: application/json

Update System Settings.

required
Array of objects (SystemParameter)

Responses

Request samples

Content type
application/json
{
  • "keyval":
    [
    ]
}

Trouble Shooting

getExecutionDetail

Get the detailed output of the given execution ID

query Parameters
id
required
string

Detailed output of the given execution ID

Responses

getExecutionList

Get the list of all the previous executions

query Parameters
limit
required
integer
Default: 10

Limit the number of executions that will be sent in the response. Default is 10

status
string
Default: "all"

Filter the executions based on the status(failed/succeeded/all)

Responses

deleteExecutions

This API will delete the execution older than specific number of days

query Parameters
days_older_by
required
integer
Default: 30

Deletes execution entries older than specified number of days

Responses