Skip to content
API Enriched

Move To API Inventory.

POST
/api/config/namespaces/{namespace}/api_definitions/{name}/move_to_inventory
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/api_definitions/example/move_to_inventory \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "api_endpoints": [ { "method": "ANY", "path": "example" } ], "name": "example", "namespace": "example" }'

Update the API Definition’s include list with the provided API endpoints.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace The namespace of the API Definition for the current request.

name
required
string

Name The name of the API Definition for the current request.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
API Inventory Request

Request shape for various API Inventory Requests.

object
api_endpoints
API Endpoints

The list of API endpoints for the API Inventory request.

Required: YES.

Array<object>
>= 1 items <= 100 items
ApiOperation

API operation according to OpenAPI specification.

object
method
string
default: ANY
Allowed values: ANY GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH COPY
path
path

An endpoint path, as specified in OpenAPI, including parameters. The path should comply with RFC 3986 and may have parameters according to OpenAPI specification Required: YES.

string
>= 1 characters <= 1024 characters
name
Name

The name of the API Definition for the current request.

string
>= 6 characters <= 1024 characters
namespace
Namespace

The namespace of the API Definition for the current request.

string
>= 6 characters <= 1024 characters

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
Update API Endpoints Schema Response

Response shape for Update API Endpoints With Newly Discovered Schema.

object
updated_api_endpoints
Updated API Endpoints

The list of API endpoints which were successfully proceeded by the API Inventory request.

Array<object>
ApiOperation

API operation according to OpenAPI specification.

object
method
string
default: ANY
Allowed values: ANY GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH COPY
path
path

An endpoint path, as specified in OpenAPI, including parameters. The path should comply with RFC 3986 and may have parameters according to OpenAPI specification Required: YES.

string
>= 1 characters <= 1024 characters
Example
{
  "updated_api_endpoints": [
    {
      "method": "ANY"
    }
  ]
}

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