Skip to content
API Enriched

Assign API Definition.

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

Set a reference to the API Definition, with an option to create an empty one if not exists.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace of the Virtual Hosts.

name
required
string

Name Name of the Virtual Hosts.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Assign API Definition Request

Request form for Assign API Definition.

object
api_definition
object
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string
>= 1 characters <= 128 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 64 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 64 characters
create_new
Create if not exists

Create an empty API Definition object, if not exists.

boolean format: boolean
name
Name

Name of the Virtual Hosts.

string
>= 6 characters <= 1024 characters
namespace
Namespace

Namespace of the Virtual Hosts.

string
>= 6 characters <= 1024 characters
Examplegenerated
{
  "api_definition": {
    "name": "example",
    "namespace": "example"
  },
  "create_new": true,
  "name": "example",
  "namespace": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
Assign API Definition Response

Response form for Assign API Definition.

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