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

Get system information

get

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

Retrieves various system information such as product name, build version, system uptime, serial number and other system-related information.

Request

Path Parameters

version(required): string

REST API version string.
Available values: v1.2

Allowed 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":{
                "systemInformation":{
                    "type":"object",
                    "properties":{
                        "productName":{
                            "type":"string",
                            "description":"Product Name"
                        },
                        "buildVersion":{
                            "type":"string",
                            "description":"Software Build Version"
                        },
                        "upTimeSeconds":{
                            "type":"integer",
                            "description":"System uptime in seconds"
                        },
                        "location":{
                            "type":"string",
                            "description":"System Location"
                        },
                        "name":{
                            "type":"string",
                            "description":"System Name"
                        },
                        "serialNum":{
                            "type":"string",
                            "description":"Serial Number"
                        }
                    },
                    "example":{
                        "productName":"Acme Packet 3900",
                        "buildVersion":"TCZ0.0.111 Alpha 17 (WS Build 93)",
                        "upTimeSeconds":"3986",
                        "location":"outerLab",
                        "name":"dev3900",
                        "serialNum":"181613000131"
                    }
                }
            }
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Show Source

systemInformation: object systemInformation

{
    "type":"object",
    "properties":{
        "systemInformation":{
            "type":"object",
            "properties":{
                "productName":{
                    "type":"string",
                    "description":"Product Name"
                },
                "buildVersion":{
                    "type":"string",
                    "description":"Software Build Version"
                },
                "upTimeSeconds":{
                    "type":"integer",
                    "description":"System uptime in seconds"
                },
                "location":{
                    "type":"string",
                    "description":"System Location"
                },
                "name":{
                    "type":"string",
                    "description":"System Name"
                },
                "serialNum":{
                    "type":"string",
                    "description":"Serial Number"
                }
            },
            "example":{
                "productName":"Acme Packet 3900",
                "buildVersion":"TCZ0.0.111 Alpha 17 (WS Build 93)",
                "upTimeSeconds":"3986",
                "location":"outerLab",
                "name":"dev3900",
                "serialNum":"181613000131"
            }
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : systemInformation

Type: object

Show Source

buildVersion: string

Software Build Version
location: string

System Location
name: string

System Name
productName: string

Product Name
serialNum: string

Serial Number
upTimeSeconds: integer

System uptime in seconds

{
    "type":"object",
    "properties":{
        "productName":{
            "type":"string",
            "description":"Product Name"
        },
        "buildVersion":{
            "type":"string",
            "description":"Software Build Version"
        },
        "upTimeSeconds":{
            "type":"integer",
            "description":"System uptime in seconds"
        },
        "location":{
            "type":"string",
            "description":"System Location"
        },
        "name":{
            "type":"string",
            "description":"System Name"
        },
        "serialNum":{
            "type":"string",
            "description":"Serial Number"
        }
    },
    "example":{
        "productName":"Acme Packet 3900",
        "buildVersion":"TCZ0.0.111 Alpha 17 (WS Build 93)",
        "upTimeSeconds":"3986",
        "location":"outerLab",
        "name":"dev3900",
        "serialNum":"181613000131"
    }
}

Example:

{
    "productName":"Acme Packet 3900",
    "buildVersion":"TCZ0.0.111 Alpha 17 (WS Build 93)",
    "upTimeSeconds":"3986",
    "location":"outerLab",
    "name":"dev3900",
    "serialNum":"181613000131"
}

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 information using curl.

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

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

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.2/system/information"
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>
    <systemInformation>
      <hostName>PRIMARY</hostName>
      <productName>Acme Packet OS VM</productName>
      <buildVersion>SCZ8.3.0 GA (Build 41)</buildVersion>
      <upTimeSeconds>145636</upTimeSeconds>
      <contact/>
      <location/>
      <name/>
      <serialNum>1111111111111111</serialNum>
    </systemInformation>
  </data>
  <messages/>
  <links/>
</response>