System API documentation version v1.0
http://api.example.com/x-nmos/system/{version}
- version: required(v1.0)
Overview
The System API allows Nodes to obtain global configuration parameters that are common across the system
Further Documentation
Further normative documentation covering the behaviour of this API is contained in the docs folder of this repository.
Base
get
List of resources available.
get /
List of resources available.
HTTP status code 200
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"description": "Describes the System API base resource",
"title": "System API base resource",
"items": {
"type": "string",
"enum": [
"global/"
]
},
"minItems": 1,
"maxItems": 1,
"uniqueItems": true
}
Example:
[
"global/"
]
Global configuration resource
get
Global configuration parameters
get /global
Global configuration parameters
HTTP status code 200
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Defines the global configuration parameters",
"title": "Global configuration resource",
"allOf": [
{ "$ref": "resource_core.json" },
{
"type": "object",
"required": [
"is04",
"ptp"
],
"properties": {
"is04": {
"description": "Constants relating to AMWA IS-04 NMOS Discovery and Registration",
"type": "object",
"required": [
"heartbeat_interval"
],
"properties": {
"heartbeat_interval": {
"description": "How often Nodes should perform a heartbeat to maintain their resources in the Registration API (in seconds)",
"type": "integer",
"default": 5,
"minimum": 1,
"maximum": 1000
}
}
},
"ptp": {
"description": "Constants relating to PTP (IEEE 1588-2008 or later)",
"type": "object",
"required": [
"announce_receipt_timeout",
"domain_number"
],
"properties": {
"announce_receipt_timeout": {
"description": "Number of announce intervals that must pass before declaring timeout",
"type": "integer",
"minimum": 2,
"maximum": 10
},
"domain_number": {
"description": "The PTP domain number",
"type": "integer",
"minimum": 0,
"maximum": 127
}
}
},
"syslogv2": {
"description": "Constants relating to syslog v2 servers using TLS transport (IETF RFC 5424, RFC 5425)",
"type": "object",
"properties": {
"hostname": {
"description": "Hostname or IP address of a syslog v2 server",
"type": "string",
"anyOf": [
{"format": "hostname"},
{"format": "ipv4"},
{"format": "ipv6"}
]
},
"port": {
"description": "Destination port number for syslog v2 messages (default 6514)",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
}
},
"syslog": {
"description": "Constants relating to syslog v1 servers using UDP transport (IETF RFC 5424, RFC 5426)",
"type": "object",
"properties": {
"hostname": {
"description": "Hostname or IP address of a syslog v1 server",
"type": "string",
"anyOf": [
{"format": "hostname"},
{"format": "ipv4"},
{"format": "ipv6"}
]
},
"port": {
"description": "Destination port number for syslog v1 messages (default 514)",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
}
}
}
}
]
}
Example:
{
"id": "3b8be755-08ff-452b-b217-c9151eb21193",
"version": "1441700172:318426300",
"label": "ZBQ System",
"description": "System Global Information for ZBQ",
"tags": {},
"is04": {
"heartbeat_interval": 8
},
"ptp": {
"announce_receipt_timeout": 2,
"domain_number": 57
},
"syslogv2": {
"hostname": "biglogger.ebu.ch",
"port": 3477
}
}