Skip to content

Allocate IP through Global IP Allocator.

POST
/api/gia/gia/allocateip
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/gia/gia/allocateip \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "context": "example", "use_v6_range": true }'

AllocateIP will allocate an IP address for the tenant read from context.

Examples of this operation.

Media typeapplication/json
AllocateIP Request

This is the input message of the ‘AllocateIP’ RPC.

object
context
context

This is the global IP allocator context from which IP allocation will happen Optional: If not specified, gia will try to allocate IP from default IP range.

string
<= 1024 characters
use_v6_range
use_v6_range

Optional: If not specified, v4 range for this tenant will be used.

boolean format: boolean
Examplegenerated
{
"context": "example",
"use_v6_range": true
}

A successful response.

Media typeapplication/json
AllocateIP Response

This is the output message of the ‘AllocateIP’ RPC.

object
error_message
error_message

Error message from global IP allocator.

string
<= 1024 characters
ip
ip address

IPv4 address in dotted decimal notation (e.g., 192.0.2.1)

string
<= 1024 characters
Examplegenerated
{
"error_message": "example",
"ip": "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