Chapter 3 /sdn/v2.0

Versions

{base uri}

This is an unauthenticated API.

List and describe all available API versions the controller provides.

Sample request 

GET /

There is no request data.

Sample response 

{
    "versions": [
        {
            "id": "/sdn/v2.0", 
            "links": [
                {
                    "href": "https://192.168.0.1:8443/sdn/v2.0", 
                    "rel": "self"
                }
            ]
        }
    ]
}

Response codes 

  • Normal: OK (200)

  • Error: Not Found (404), Service Unavailable (503)

{base uri}/{api}

This is an unauthenticated API.

Sample request 

GET /sdn/v2.0

There is no request data.

Describe useful URIs provided by a specific version of the REST API.

Sample response 

{
    "version": {
        "build": "1.21.0.0000", 
        "id": "/sdn/v2.0/", 
        "links": [
            {
                "href": "https://192.168.0.1:8443/sdn/v2.0/", 
                "rel": "self"
            }, 
            {
                "href": "https://192.168.0.1:8443/sdn/v2.0/models", 
                "rel": "describedBy", 
                "type": "application/json"
            }, 
            {
                "href": "https://192.168.0.1:8443/api", 
                "rel": "describedBy", 
                "type": "text/html"
            }
        ], 
        "status": "CURRENT"
    }
}

Response codes 

  • Normal: OK (200)

  • Error: Not Found (404), Service Unavailable (503)