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

Get system version information

get

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

Retrieves the current system software version. This includes product name, build version, build date, and other relevant 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":{
                "systemVersionInfo":{
                    "type":"object",
                    "required":[
                        "productName",
                        "buildVersion",
                        "oracleLinuxInfo",
                        "buildDate",
                        "buildView",
                        "buildCycle",
                        "user",
                        "host"
                    ],
                    "properties":{
                        "productName":{
                            "type":"string",
                            "example":"Acme Packet OS VM"
                        },
                        "buildVersion":{
                            "type":"string",
                            "example":"TCZ0.0.111 Alpha 14 (WS Build 85)"
                        },
                        "oracleLinuxInfo":{
                            "type":"string",
                            "example":"branches-7/el7-u5 {2018-07-23T07:00:00+0000}"
                        },
                        "buildDate":{
                            "type":"string",
                            "example":"2018-09-05T08:41:55.0-0400"
                        },
                        "buildView":{
                            "type":"string",
                            "example":"/home/acmedev/cc/acmedev_RESTLESS_BUILD-6"
                        },
                        "buildCycle":{
                            "type":"integer",
                            "example":"55"
                        },
                        "user":{
                            "type":"string",
                            "example":"acmedev"
                        },
                        "host":{
                            "type":"string",
                            "example":"acme123"
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Show Source

systemVersionInfo: object systemVersionInfo

{
    "type":"object",
    "properties":{
        "systemVersionInfo":{
            "type":"object",
            "required":[
                "productName",
                "buildVersion",
                "oracleLinuxInfo",
                "buildDate",
                "buildView",
                "buildCycle",
                "user",
                "host"
            ],
            "properties":{
                "productName":{
                    "type":"string",
                    "example":"Acme Packet OS VM"
                },
                "buildVersion":{
                    "type":"string",
                    "example":"TCZ0.0.111 Alpha 14 (WS Build 85)"
                },
                "oracleLinuxInfo":{
                    "type":"string",
                    "example":"branches-7/el7-u5 {2018-07-23T07:00:00+0000}"
                },
                "buildDate":{
                    "type":"string",
                    "example":"2018-09-05T08:41:55.0-0400"
                },
                "buildView":{
                    "type":"string",
                    "example":"/home/acmedev/cc/acmedev_RESTLESS_BUILD-6"
                },
                "buildCycle":{
                    "type":"integer",
                    "example":"55"
                },
                "user":{
                    "type":"string",
                    "example":"acmedev"
                },
                "host":{
                    "type":"string",
                    "example":"acme123"
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : systemVersionInfo

Type: object

Show Source

buildCycle(required): integer

Example: 55
buildDate(required): string

Example: 2018-09-05T08:41:55.0-0400
buildVersion(required): string

Example: TCZ0.0.111 Alpha 14 (WS Build 85)
buildView(required): string

Example: /home/acmedev/cc/acmedev_RESTLESS_BUILD-6
host(required): string

Example: acme123
oracleLinuxInfo(required): string

Example: branches-7/el7-u5 {2018-07-23T07:00:00+0000}
productName(required): string

Example: Acme Packet OS VM
user(required): string

Example: acmedev

{
    "type":"object",
    "required":[
        "productName",
        "buildVersion",
        "oracleLinuxInfo",
        "buildDate",
        "buildView",
        "buildCycle",
        "user",
        "host"
    ],
    "properties":{
        "productName":{
            "type":"string",
            "example":"Acme Packet OS VM"
        },
        "buildVersion":{
            "type":"string",
            "example":"TCZ0.0.111 Alpha 14 (WS Build 85)"
        },
        "oracleLinuxInfo":{
            "type":"string",
            "example":"branches-7/el7-u5 {2018-07-23T07:00:00+0000}"
        },
        "buildDate":{
            "type":"string",
            "example":"2018-09-05T08:41:55.0-0400"
        },
        "buildView":{
            "type":"string",
            "example":"/home/acmedev/cc/acmedev_RESTLESS_BUILD-6"
        },
        "buildCycle":{
            "type":"integer",
            "example":"55"
        },
        "user":{
            "type":"string",
            "example":"acmedev"
        },
        "host":{
            "type":"string",
            "example":"acme123"
        }
    }
}

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

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

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

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.2/system/version"
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>
    <systemVersionInfo>
      <productName>Acme Packet OS VM</productName>
      <buildVersion>TCZ0.0.111 Alpha 24 (WS Build 141)</buildVersion>
      <oracleLinuxInfo>branches-7/el7-u6 {2019-01-03T07:00:00+0000}</oracleLinuxInfo>
      <buildDate>2019-01-12</buildDate>
      <buildView>/home/acme/cc/RESTLESS_WS_integration</buildView>
      <buildCycle>70</buildCycle>
      <user>WSbuilder</user>
      <host>maverick</host>
    </systemVersionInfo>
  </data>
  <messages/>
  <links/>
</response>