Powered by Redocly

Subtenant Volga Infras

FIXME.

Create a new volga infra

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$
chunks
integer <uint32>
Default: 1000
persistence
string <enumeration>
Default: "disk"
  • disk
  • ram
format
required
string <enumeration>
  • string: The message payload is a string.
  • json: The message payload is an arbitrary json object.

The format of messages on this infra.

allow-stitch
boolean
Default: false

Allow messages on this infra to be passed from site to site via the control tower

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict (instance exists)

503

Service Unavailable (strongbox sealed)

post/v1/config/tenants/{tenant-name}/volga/infras
Request samples 
name: myinfra
chunks: 1000
persistence: disk
format: string
allow-stitch: false

Retrieve the configuration of all volga infras

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/tenants/{tenant-name}/volga/infras
Response samples 
- name: myinfra
  chunks: 1000
  persistence: disk
  format: string
  allow-stitch: false

Update a volga infra

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

volga-infra-name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$

name of volga-infra

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$
chunks
integer <uint32>
Default: 1000
persistence
string <enumeration>
Default: "disk"
  • disk
  • ram
format
required
string <enumeration>
  • string: The message payload is a string.
  • json: The message payload is an arbitrary json object.

The format of messages on this infra.

allow-stitch
boolean
Default: false

Allow messages on this infra to be passed from site to site via the control tower

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/tenants/{tenant-name}/volga/infras/{volga-infra-name}
Request samples 
name: myinfra
chunks: 1000
persistence: disk
format: string
allow-stitch: false

Delete a volga infra

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

volga-infra-name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$

name of volga-infra

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/tenants/{tenant-name}/volga/infras/{volga-infra-name}

Replace or create a new volga infra

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

volga-infra-name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$

name of volga-infra

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$
chunks
integer <uint32>
Default: 1000
persistence
string <enumeration>
Default: "disk"
  • disk
  • ram
format
required
string <enumeration>
  • string: The message payload is a string.
  • json: The message payload is an arbitrary json object.

The format of messages on this infra.

allow-stitch
boolean
Default: false

Allow messages on this infra to be passed from site to site via the control tower

Responses
201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/tenants/{tenant-name}/volga/infras/{volga-infra-name}
Request samples 
name: myinfra
chunks: 1000
persistence: disk
format: string
allow-stitch: false

Retrieve the configuration of a volga infra

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

volga-infra-name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$

name of volga-infra

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/tenants/{tenant-name}/volga/infras/{volga-infra-name}
Response samples 
name: myinfra
chunks: 1000
persistence: disk
format: string
allow-stitch: false

Retrieve the state of all volga infras

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/tenants/{tenant-name}/volga/infras
Response samples 
- name: myinfra
  chunks: 1000
  persistence: disk
  format: string
  allow-stitch: false

Retrieve the state of a volga infra

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

volga-infra-name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$

name of volga-infra

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/tenants/{tenant-name}/volga/infras/{volga-infra-name}
Response samples 
name: myinfra
chunks: 1000
persistence: disk
format: string
allow-stitch: false
➔ Next to Subtenant OS upgrade host state