Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET system_files/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns meta data information used with the Import & Export methods.
Resource URL
http://{host}/api/2.0/system_files/meta/.format
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"ImportExportOptions": {
"1": "All",
"2": "Users",
"3": "Network, Device Name, License Sharing State",
"4": "Channels and Scheduling",
"5": "Threshold Sets",
"6": "Notification Sets and Agents",
"7": "DNS, NTP, PTP",
"8": "External IRD",
"9": "Layouts",
"10": "Encoders",
"11": "Channels Monitoring State",
"12": "Time Zone Settings",
"13": "Key Servers",
"14": "Certificates"
}
} |
Returns a list of configuration files currently available in the system.
Resource URL
http://{host}/api/2.0/system_files/.format
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
[
{
"SystemFile": {
"id": 15,
"filename": "mcm9011_2021_05_02.xml",
"description": "MCM-9000 configuration",
"size": 315245,
"version": "5.5.0dbg7",
"modified": "1619961399292",
"created": "1619961399292"
}
},
{
"SystemFile": {
"id": 16,
"filename": "mcm9011_2021_05_02_01.xml",
"description": "MCM-9000 configuration",
"size": 224896,
"version": "5.5.0dbg7",
"modified": "1619961442811",
"created": "1619961442811"
}
}
] |
DELETE system_files/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Deletes a single specific File.
Resource URL
http://{host}/api/2.0/system_files/{id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
id | integer | The ID of the desired system file to be deleted. |
Example Request
DELETE
| Code Block | ||
|---|---|---|
| ||
{
"success": true
} |
GET system_files/command/importConfigurationFile/{file_id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Imports & activates a specific configuration file into the system.
Resource URL
http://{host}/api/2.0/system_files/command/importConfigurationFile/{file_id}.format?options[]=2&options[]=3
Parameters
Parameter | Data Type | Description |
|---|---|---|
file_id | integer | The ID of the desired system file to be imported. |
options[]=value | integer | Configuration file to be ingested. For example, if you need all the configuration files write options[]=1. |
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"Task": {
"id": 920684,
"device_id": 9011,
"type": "Import Configuration File",
"type_id": 2,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1619961634955"
}
} |
GET system_files/command/exportConfigurationFile
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Exports the current system's configuration into a new configuration file.
Resource URL
http://{host}/api/2.0/system_files/command/exportConfigurationFile.format
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"Task": {
"id": 115218,
"device_id": 9011,
"type": "Export Configuration File",
"type_id": 3,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1619961548358"
}
} |