REST API for Session Border Controller Release 8.3

Get supported REST API versions

get

https://{managementIp}/rest/api/supportedversions

Retrieve a list of the supported REST API versions for this software release.

Request

There are no request parameters for this operation.

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":{
                "supportedVersions":{
                    "type":"object",
                    "properties":{
                        "otherVersions":{
                            "items":{
                                "type":"object",
                                "properties":{
                                    "version":{
                                        "type":"string",
                                        "example":"v1.0"
                                    }
                                }
                            },
                            "type":"array",
                            "description":"Previous API versions for backwards compatibility"
                        },
                        "latestVersion":{
                            "type":"string",
                            "description":"Latest API version",
                            "example":"v1.1"
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Show Source

supportedVersions(optional): object supportedVersions

{
    "type":"object",
    "properties":{
        "supportedVersions":{
            "type":"object",
            "properties":{
                "otherVersions":{
                    "items":{
                        "type":"object",
                        "properties":{
                            "version":{
                                "type":"string",
                                "example":"v1.0"
                            }
                        }
                    },
                    "type":"array",
                    "description":"Previous API versions for backwards compatibility"
                },
                "latestVersion":{
                    "type":"string",
                    "description":"Latest API version",
                    "example":"v1.1"
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : supportedVersions

Type: object

Show Source

latestVersion(optional): string

Latest API version

Example: v1.1
otherVersions(optional): array otherVersions

Previous API versions for backwards compatibility

{
    "type":"object",
    "properties":{
        "otherVersions":{
            "items":{
                "type":"object",
                "properties":{
                    "version":{
                        "type":"string",
                        "example":"v1.0"
                    }
                }
            },
            "type":"array",
            "description":"Previous API versions for backwards compatibility"
        },
        "latestVersion":{
            "type":"string",
            "description":"Latest API version",
            "example":"v1.1"
        }
    }
}

Nested Schema : otherVersions

Type: array

Previous API versions for backwards compatibility

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "version":{
                "type":"string",
                "example":"v1.0"
            }
        }
    },
    "type":"array",
    "description":"Previous API versions for backwards compatibility"
}

Nested Schema : items

Type: object

Show Source

version(optional): string

Example: v1.0

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "example":"v1.0"
        }
    }
}

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

This API must not contain a version number

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 supported REST API 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/api/supportedversions"

Example of Accessing the API with Python

The following example shows how to get supported REST API 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/api/supportedversions"
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: Fri, 04 Jan 2019 16:55:29 GMT
Cache-Control: no-cache
Content-Length: 270
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Fri, 04 Jan 2019 16:55:29 GMT
X-Appweb-Seq: 16

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>
    <supportedVersions>
      <latestVersion>v1.1</latestVersion>
      <otherVersions>
        <version>v1.0</version>
      </otherVersions>
    </supportedVersions>
  </data>
  <messages/>
  <links/>
</response>