REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 9.3.0

Get system status information

get

https://{managementIp}/rest/{version}/system/status

Retrieves the system uptime, system health, and HA/redundancy information (if configured as an HA system).

Request

Path Parameters

version(required): string

REST API version string.
Available values: v1.2

Header Parameters

Authorization(required):

The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

There's no request body for this operation.

Response

Supported Media Types

application/xml

200 Response

OK - Requested data is returned in response body

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): object links
messages(required): object messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object",
            "properties":{
                "upTime":{
                    "type":"integer",
                    "example":861830
                },
                "hostName":{
                    "type":"string",
                    "example":"thewater-sd"
                },
                "systemState":{
                    "type":"string",
                    "enum":[
                        "online",
                        "offline"
                    ],
                    "example":"online"
                },
                "role":{
                    "type":"string",
                    "enum":[
                        "active",
                        "standby",
                        "out of service"
                    ],
                    "example":"active"
                },
                "healthScorePercent":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":100,
                    "example":100
                },
                "haSyncState":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "component":{
                                "type":"object",
                                "properties":{
                                    "name":{
                                        "type":"string",
                                        "example":"tCCD"
                                    },
                                    "state":{
                                        "type":"string",
                                        "enum":[
                                            "disabled",
                                            "enabled",
                                            true,
                                            false
                                        ],
                                        "example":"disabled"
                                    }
                                }
                            }
                        }
                    }
                },
                "haSockets":{
                    "type":"integer",
                    "example":2
                },
                "haHealthScorePercent":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":100,
                    "example":100
                },
                "haPeerName":{
                    "type":"string",
                    "example":"thewater-ed"
                },
                "haPeerRole":{
                    "type":"string",
                    "enum":[
                        "active",
                        "standby",
                        "out of service"
                    ],
                    "example":"standby"
                },
                "haSwitchOvers":{
                    "type":"integer",
                    "example":2
                },
                "switchOverLogs":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "switchOver":{
                                "type":"object",
                                "properties":{
                                    "newState":{
                                        "type":"string",
                                        "enum":[
                                            "Active",
                                            "RelinquishingActive"
                                        ],
                                        "example":"RelinquishingActive"
                                    },
                                    "oldState":{
                                        "type":"string",
                                        "enum":[
                                            "Active",
                                            "RelinquishingActive"
                                        ],
                                        "example":"Active"
                                    },
                                    "info":{
                                        "type":"string",
                                        "example":"Active to RelinquishingActive, forced by command"
                                    },
                                    "time":{
                                        "type":"string",
                                        "example":"2018-09-05T08:41:55.0-0400"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Show Source

haHealthScorePercent: integer

Minimum Value: 0

Maximum Value: 100

Example: 100
haPeerName: string

Example: thewater-ed
haPeerRole: string

Allowed Values: [ "active", "standby", "out of service" ]

Example: standby
haSockets: integer

Example: 2
haSwitchOvers: integer

Example: 2
haSyncState: array haSyncState
healthScorePercent: integer

Minimum Value: 0

Maximum Value: 100

Example: 100
hostName: string

Example: thewater-sd
role: string

Allowed Values: [ "active", "standby", "out of service" ]

Example: active
switchOverLogs: array switchOverLogs
systemState: string

Allowed Values: [ "online", "offline" ]

Example: online
upTime: integer

Example: 861830

{
    "type":"object",
    "properties":{
        "upTime":{
            "type":"integer",
            "example":861830
        },
        "hostName":{
            "type":"string",
            "example":"thewater-sd"
        },
        "systemState":{
            "type":"string",
            "enum":[
                "online",
                "offline"
            ],
            "example":"online"
        },
        "role":{
            "type":"string",
            "enum":[
                "active",
                "standby",
                "out of service"
            ],
            "example":"active"
        },
        "healthScorePercent":{
            "type":"integer",
            "minimum":0,
            "maximum":100,
            "example":100
        },
        "haSyncState":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "component":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "example":"tCCD"
                            },
                            "state":{
                                "type":"string",
                                "enum":[
                                    "disabled",
                                    "enabled",
                                    true,
                                    false
                                ],
                                "example":"disabled"
                            }
                        }
                    }
                }
            }
        },
        "haSockets":{
            "type":"integer",
            "example":2
        },
        "haHealthScorePercent":{
            "type":"integer",
            "minimum":0,
            "maximum":100,
            "example":100
        },
        "haPeerName":{
            "type":"string",
            "example":"thewater-ed"
        },
        "haPeerRole":{
            "type":"string",
            "enum":[
                "active",
                "standby",
                "out of service"
            ],
            "example":"standby"
        },
        "haSwitchOvers":{
            "type":"integer",
            "example":2
        },
        "switchOverLogs":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "switchOver":{
                        "type":"object",
                        "properties":{
                            "newState":{
                                "type":"string",
                                "enum":[
                                    "Active",
                                    "RelinquishingActive"
                                ],
                                "example":"RelinquishingActive"
                            },
                            "oldState":{
                                "type":"string",
                                "enum":[
                                    "Active",
                                    "RelinquishingActive"
                                ],
                                "example":"Active"
                            },
                            "info":{
                                "type":"string",
                                "example":"Active to RelinquishingActive, forced by command"
                            },
                            "time":{
                                "type":"string",
                                "example":"2018-09-05T08:41:55.0-0400"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : haSyncState

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "component":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "example":"tCCD"
                    },
                    "state":{
                        "type":"string",
                        "enum":[
                            "disabled",
                            "enabled",
                            true,
                            false
                        ],
                        "example":"disabled"
                    }
                }
            }
        }
    }
}

Nested Schema : switchOverLogs

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "switchOver":{
                "type":"object",
                "properties":{
                    "newState":{
                        "type":"string",
                        "enum":[
                            "Active",
                            "RelinquishingActive"
                        ],
                        "example":"RelinquishingActive"
                    },
                    "oldState":{
                        "type":"string",
                        "enum":[
                            "Active",
                            "RelinquishingActive"
                        ],
                        "example":"Active"
                    },
                    "info":{
                        "type":"string",
                        "example":"Active to RelinquishingActive, forced by command"
                    },
                    "time":{
                        "type":"string",
                        "example":"2018-09-05T08:41:55.0-0400"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

component: object component

{
    "type":"object",
    "properties":{
        "component":{
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "example":"tCCD"
                },
                "state":{
                    "type":"string",
                    "enum":[
                        "disabled",
                        "enabled",
                        true,
                        false
                    ],
                    "example":"disabled"
                }
            }
        }
    }
}

Nested Schema : component

Type: object

Show Source

name: string

Example: tCCD
state: string

Allowed Values: [ "disabled", "enabled", true, false ]

Example: disabled

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"tCCD"
        },
        "state":{
            "type":"string",
            "enum":[
                "disabled",
                "enabled",
                true,
                false
            ],
            "example":"disabled"
        }
    }
}

Nested Schema : items

Type: object

Show Source

switchOver: object switchOver

{
    "type":"object",
    "properties":{
        "switchOver":{
            "type":"object",
            "properties":{
                "newState":{
                    "type":"string",
                    "enum":[
                        "Active",
                        "RelinquishingActive"
                    ],
                    "example":"RelinquishingActive"
                },
                "oldState":{
                    "type":"string",
                    "enum":[
                        "Active",
                        "RelinquishingActive"
                    ],
                    "example":"Active"
                },
                "info":{
                    "type":"string",
                    "example":"Active to RelinquishingActive, forced by command"
                },
                "time":{
                    "type":"string",
                    "example":"2018-09-05T08:41:55.0-0400"
                }
            }
        }
    }
}

Nested Schema : switchOver

Type: object

Show Source

info: string

Example: Active to RelinquishingActive, forced by command
newState: string

Allowed Values: [ "Active", "RelinquishingActive" ]

Example: RelinquishingActive
oldState: string

Allowed Values: [ "Active", "RelinquishingActive" ]

Example: Active
time: string

Example: 2018-09-05T08:41:55.0-0400

{
    "type":"object",
    "properties":{
        "newState":{
            "type":"string",
            "enum":[
                "Active",
                "RelinquishingActive"
            ],
            "example":"RelinquishingActive"
        },
        "oldState":{
            "type":"string",
            "enum":[
                "Active",
                "RelinquishingActive"
            ],
            "example":"Active"
        },
        "info":{
            "type":"string",
            "example":"Active to RelinquishingActive, forced by command"
        },
        "time":{
            "type":"string",
            "example":"2018-09-05T08:41:55.0-0400"
        }
    }
}

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

401 Response

Unauthorized - Request lacks valid authentication credentials.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

404 Response

Resource not found

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

curl
Python

The following example shows how to get system status information using curl.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.2/system/status"

The following example shows how to get system status information using Python.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.2/system/status"
resp = requests.get(url, headers=headers)

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <uptimeSeconds>146091</uptimeSeconds>
    <hostName>PRIMARY</hostName>
    <systemState>online</systemState>
    <role>standalone</role>
    <healthScorePercent>100</healthScorePercent>
  </data>
  <messages/>
  <links/>
</response>