REST API for Session Border Controller Release 8.3

Execute HA switchover

post

https://{managementIp}/rest/{version}/admin/switchover

Executes an HA switchover to switch from the active server to the standby server.

For more information on high availability, see High Availability in the ACLI Configuration Guide.

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

204 Response

HA switchover request received. The switchover operation can take up to five seconds after the SBC sends a response to the client.

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"
        }
    }
}

403 Response

This request requires the client credentials to have administrator privileges.

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

Unsupported versionId in URI.

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 execute an HA switchover by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://10.0.0.2/rest/v1.1/admin/switchover"

Example of Accessing the API with Python

The following example shows how to execute an HA switchover by submitting a POST 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/admin/switchover"
resp = requests.post(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Date: Fri, 11 Jan 2019 16:24:18 GMT
Cache-Control: no-cache
Content-Length: 0
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Fri, 11 Jan 2019 16:24:18 GMT
X-Appweb-Seq: 3

Example of the Response Body

This endpoint does not return a response body.