API docs by Redocly

System Service (3.7.0)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: http://www.extremenetworks.com License: Apache license

This spec defines the API provided by the application to validate authorization for the system.

Feature Setting

Get feature setting list.

Authorizations:
bearerAuth

Responses

Response samples

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

Update feature setting.

Authorizations:
bearerAuth
Request Body schema: application/json
optional

Update feature settings.

required
Array of objects (FeatureParameter)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "Error",
  • "code": 101
}

System Setting

Get system setting.

Authorizations:
bearerAuth
query Parameters
decrypt
boolean
Default: false

Decrypt password and display in plain text

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Update system setting.

Authorizations:
bearerAuth
Request Body schema: application/json
optional

Update system settings.

required
Array of objects (SystemParameter)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "Error",
  • "code": 101
}

Reset system setting.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Reset system settings.

Array
string

Responses

Request samples

Content type
application/json
[
  • "BackupSchedule",
  • "MaxBackupFiles",
  • "MaxSsFiles",
  • "RemoteServerSettings",
  • "PeriodicDeviceConfigBackup"
]

Response samples

Content type
application/json
{
  • "message": "Error",
  • "code": 101
}

Troubleshooting

Get execution detail.

Get the detailed output of a request previously executed, based on a given request ID.

Authorizations:
bearerAuth
query Parameters
id
required
string

Detailed output of the given execution ID.

Responses

Response samples

Content type
application/json
{
  • "start_time": "2000-01-23T04:56:07.000+00:00",
  • "end_time": "2000-01-23T04:56:07.000+00:00",
  • "id": "id",
  • "logs": "logs",
  • "URL": "/v1/inventory/switches",
  • "status": "Failed, Succeeded"
}

Get execution list.

Get the list of all the requests previously executed.

Authorizations:
bearerAuth
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

Response samples

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

Delete executions.

Delete all requests that were executed earlier than the specific number of days.

Authorizations:
bearerAuth
query Parameters
days_older_by
required
integer
Default: 30

Delete all requests that were executed earlier than the specific number of days.

Responses

Response samples

Content type
application/json
{
  • "message": "Error",
  • "code": 101
}

GetRunningConfig

Get the list of all CLIs in Running Config

Authorizations:
bearerAuth

Responses

Response samples

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

Clean

Clean up archives.

Clean up backup and supportsave archives.

Authorizations:
bearerAuth
query Parameters
archive_type
required
string
Enum: "backup" "supportsave"

Type of archive that has to be deleted.

name
required
string

Name of archive that has to be deleted.

Responses

Response samples

Content type
application/json
{
  • "message": "successfully deleted the archive"
}

Logging Customization

Get Logging Customization configuration.

Authorizations:
bearerAuth
query Parameters
services
string

Comma separated list of services to get logging customization configuration.

logging_types
string

Comma separated list of logging types to get logging customization configuration.

Responses

Response samples

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

Update Logging Customization.

Authorizations:
bearerAuth
Request Body schema: application/json
optional

Update Logging Customization configuration.

services
string

Name of the services

logging_types
string

Name of the logging types

file_size
string

Maximum size of logging file

file_count
string

Number of log files

detail_level
string

Level of logging detail to be logged.

Responses

Request samples

Content type
application/json
{
  • "service": "all,auth,fabric,faultmanager,hyperv,inventory,notification,policy,raslog,rbac,system,tenant,vcenter",
  • "logging_type": "all",
  • "file_size": 100,
  • "file_count": 10,
  • "detail_level": "debugging"
}

Response samples

Content type
application/json
[
  • {
    }
]

Clear Logging Customization.

Clear Logging Customizations to default configuration.

Authorizations:
bearerAuth
query Parameters
services
string
Enum: "all" "auth" "fabric" "faultmanager" "hyperv" "inventory" "notification" "policy" "raslog" "rbac" "system" "tenant" "vcenter"

Comma separated list of services to clear logging customization configuration.

logging_types
string

Comma separated list of logging types to clear logging customization configuration.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FileDownload

Get any file from XCO system.

Transfers any file provided with correct path transferred to XCO UI

Authorizations:
bearerAuth
query Parameters
name
required
string

File name which is required to be downloaded of type given below

file_type
required
string
Enum: "backup" "supportsave"

Type of file that has to be downloaded.

Responses

Response samples

Content type
application/json
{
  • "message": "Error",
  • "code": 101
}

SupportSave

Fetch SupportSave files.

Get the list of available SupportSave files.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Trigger the support save

This API will start the support save collection in async mode

Authorizations:
bearerAuth
Request Body schema: application/json

Supportsave request.

fabric
string
device-ips
string
fabric-all
boolean

Responses

Request samples

Content type
application/json
{
  • "fabric": "string",
  • "device-ips": "10.24.131.3,162.101.21.2,192.24.32.204",
  • "fabric-all": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ss_file_name": "string",
  • "status": "in-progress",
  • "date": "2022-06-20"
}

SupportSaveStatus

Fetch SupportSave status.

Get the current support save status

Authorizations:
bearerAuth
query Parameters
id
required
string

Request ID for which status to be returned

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ss_file_name": "string",
  • "status": "in-progress",
  • "date": "2022-06-20"
}

Health

Fetch health status.

Get the health of XCO.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "version": "3.2.0",
  • "build": "GA",
  • "date": "2022-06-20",
  • "nodes": [
    ],
  • "health": [
    ]
}