Skip to content

Upgrade OS.

POST
/api/config/namespaces/{namespace}/sites/{name}/upgrade_os
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/sites/example/upgrade_os \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "force": true, "name": "example", "namespace": "example", "version": "example" }'

Upgrade Site OS version.

Examples of this operation.

namespace
required
string

Namespace

x-required Site namespace.

name
required
string

Name

x-required Site name.

Media typeapplication/json
Upgrade OS request

Request for Upgrade OS of Site.

object
force
Force

Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress) Required: YES.

boolean format: boolean
name
Name

Site name Required: YES.

string
>= 6 characters <= 1024 characters
namespace
Namespace

Site namespace Required: YES.

string
>= 6 characters <= 1024 characters
version
SW/OS Version

Version to upgraded to Required: YES.

string
>= 1 characters <= 1024 characters
Examplegenerated
{
"force": true,
"name": "example",
"namespace": "example",
"version": "example"
}

A successful response.

Media typeapplication/json
Upgrade OS Response

Response for OS Upgrade Request, empty because the only returned information is currently error message.

object
Examplegenerated
{}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example