Skip to content

Add Override.

POST
/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/override/push
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/ml/data/namespaces/example/app_types/example/override/push \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "app_type_name": "example", "namespace": "example", "override_info": { "component_identifier": "example", "set_dynamic": true } }'

Add override for dynamic component for API endpoints discovered for this App type.

Examples of this operation.

namespace
required
string

Namespace Namespace of the App type for current request.

app_type_name
required
string

App Type App Type for current request.

Media typeapplication/json
Add API endpoint override request

Shape of request to add override for API endpoints.

object
app_type_name
App Type

App Type for current request.

string
<= 1024 characters
namespace
Namespace

Namespace of the App type for current request.

string
>= 6 characters <= 1024 characters
override_info
object
component_identifier
Override component identifier

Configuration parameter for component identifier

string
<= 1024 characters
set_dynamic
Override Value

Enable or Disable component to be considered as dynamic to collapse or expand API URL.

boolean format: boolean
Examplegenerated
{
"app_type_name": "example",
"namespace": "example",
"override_info": {
"component_identifier": "example",
"set_dynamic": true
}
}

A successful response.

Media typeapplication/json
Add API endpoint override response

Shape of response to add override for API endpoints.

object
status
Status

Status of the add operation (success or fail)

boolean format: boolean
>= 17 characters <= 17 characters
status_msg
Message

Message string for the status of add operation.

string
<= 1024 characters
Examplegenerated
{
"status": true,
"status_msg": "example"
}

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