REST API for Session Border Controller Release 8.3

Get current and running configuration versions

get

https://{managementIp}/rest/{version}/configuration/versions

Retrieves the version numbers of the current and running configuration. This integer value is incremented by one for each new configuration version.

Request

Path Parameters

version: string

REST API version string.
Available values: v1.1

Header Parameters

Authorization:

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: object data
links: object links
messages: object messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "properties":{
                "configVersions":{
                    "required":[
                        "currentVersion",
                        "runningVersion"
                    ],
                    "type":"object",
                    "properties":{
                        "currentVersion":{
                            "type":"integer",
                            "example":54
                        },
                        "runningVersion":{
                            "type":"integer",
                            "example":53
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Show Source

configVersions(optional): object configVersions

{
    "type":"object",
    "properties":{
        "configVersions":{
            "required":[
                "currentVersion",
                "runningVersion"
            ],
            "type":"object",
            "properties":{
                "currentVersion":{
                    "type":"integer",
                    "example":54
                },
                "runningVersion":{
                    "type":"integer",
                    "example":53
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : configVersions

Type: object

Show Source

currentVersion: integer

Example: 54
runningVersion: integer

Example: 53

{
    "required":[
        "currentVersion",
        "runningVersion"
    ],
    "type":"object",
    "properties":{
        "currentVersion":{
            "type":"integer",
            "example":54
        },
        "runningVersion":{
            "type":"integer",
            "example":53
        }
    }
}

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: object data
links: array links
messages: array messages

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

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

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

Nested Schema : messages

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

link(optional): 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":{
            "type":"string",
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage(optional): 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: object data
links: array links
messages: array messages

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

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

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

Nested Schema : messages

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

link(optional): 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":{
            "type":"string",
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage(optional): 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: object data
links: array links
messages: array messages

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

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

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

Nested Schema : messages

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

link(optional): 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":{
            "type":"string",
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage(optional): string

Example: Error message string

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

Examples

Example of Accessing the API with cURL

The following example shows how to get current and running configuration versions by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://10.0.0.2/rest/v1.1/configuration/versions"

Example of Accessing the API with Python

The following example shows how to get current and running configuration versions by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://10.0.0.2/rest/v1.1/configuration/versions"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Mon, 14 Jan 2019 22:51:17 GMT
Cache-Control: no-cache
Content-Length: 234
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Mon, 14 Jan 2019 22:51:17 GMT
X-Appweb-Seq: 151

Example of the Response Body

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <configVersions>
      <currentVersion>2</currentVersion>
      <runningVersion>2</runningVersion>
    </configVersions>
  </data>
  <messages/>
  <links/>
</response>