Skip to content

Registration Config.

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

API endpoint for returning configuration for admitted registrations. It will fail with known error for non-ADMITTED registration.

Examples of this operation.

Media typeapplication/json
Configuration request

Request to GET configuration.

object
name
Name

Registration name Required: YES.

string
>= 6 characters <= 1024 characters
namespace
Namespace

Registration namespace Required: YES.

string
>= 6 characters <= 1024 characters
token
Token

Token - verify node identity Required: YES.

string
<= 1024 characters
Examplegenerated
{
"name": "example",
"namespace": "example",
"token": "example"
}

A successful response.

Media typeapplication/json
Configuration

Response for configuration request. This response is consumed by node.

object
hash
Hash

Hash of workload map which is used to verify consistency and check changes.

string
<= 1024 characters
workload
Workload

Configuration for applications and infrastructure.

object
Examplegenerated
{
"hash": "example",
"workload": {}
}

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