Skip to content
API Enriched

Set site state.

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

Request changing site state but this request goes through validation as some trainsitions are not allowed. It can be used to decomission site by sending state DECOMISSIONING. Example of forbidden state is PROVISIONING and UPGRADING.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace

x-required Site namespace.

name
required
string

Name

x-required Site name.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Set state request

Set status of the site.

object
name
Name

Site name Required: YES.

string
>= 6 characters <= 1024 characters
namespace
Namespace

Site namespace Required: YES.

string
>= 6 characters <= 1024 characters
state
string
default: ONLINE
Allowed values: ONLINE PROVISIONING UPGRADING STANDBY FAILED REREGISTRATION WAITINGNODES DECOMMISSIONING WAITING_FOR_REGISTRATION ORCHESTRATION_IN_PROGRESS ORCHESTRATION_COMPLETE ERROR_IN_ORCHESTRATION DELETING_CLOUD_RESOURCES DELETED_CLOUD_RESOURCES ERROR_DELETING_CLOUD_RESOURCES VALIDATION_IN_PROGRESS VALIDATION_SUCCESS VALIDATION_FAILED FAILED_INACTIVE UPDATING_CLOUD_RESOURCES ERROR_UPDATING_CLOUD_RESOURCES ORCHESTRATION_QUEUED UPDATE_QUEUED DELETE_QUEUED

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
Set state responde

Response for set state request, empty because the only resturned information is currently error message.

object
Examplegenerated
{}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example