Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Virtual Private Cloud
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Cloud network
      • Creating a cloud network
      • Deleting a cloud network
      • Updating a cloud network
      • Moving a cloud network between folders
    • Subnet
      • Creating a subnet
      • Deleting a subnet
      • Updating a subnet
      • Moving a subnet between folders
      • Viewing a list of used addresses
    • IP address
      • Reserving a static public IP address
      • Making a dynamic public IP address static
      • Making a static public IP address dynamic
      • Moving an address between folders
      • Deleting a static public IP address
    • Static routing
      • Creating static routes
      • Enabling NAT to the internet
      • Creating and setting up a NAT gateway
      • Moving a route table between folders
      • Moving a NAT gateway between folders
    • Security groups
      • Create a security group
      • Changing the name and description
      • Adding a new rule
      • Delete a rule
      • Moving a security group between folders
      • Delete a security group
    • Enable a software-accelerated network
    • DDoS protection
      • Enable protection from DDoS attacks
    • Chart of network connections
  • Practical guidelines
    • All tutorials
    • Architecture and protection of a basic internet service
    • Routing through a NAT instance
    • Creating an IPSec VPN tunnel
    • Installing a Cisco CSR 1000v virtual router
    • Installing a Mikrotik CHR virtual router
    • Connecting to a cloud network using OpenVPN
    • Creating and configuring a UserGate gateway in proxy server mode
    • Configuring networks for Yandex Data Proc
  • Concepts
    • Relationships between service resources
    • Cloud networks and subnets
    • Cloud resource addresses
    • Static routes
    • Security groups
    • Gateways
    • Monitoring network connections
    • Public IP address ranges
    • MTU and MSS
    • DHCP settings
    • Software-accelerated network
    • Quotas and limits
  • DDoS Protection
  • Recommendations
    • Using public IP addresses
  • Access management
  • Pricing policy
    • Current pricing policy
    • Archive
      • Before January 1, 2019
  • API reference
    • Authentication in the API
    • REST
      • Overview
      • Address
        • Overview
        • create
        • delete
        • get
        • getByValue
        • list
        • listOperations
        • move
        • update
      • Gateway
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • update
      • Network
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • listRouteTables
        • listSecurityGroups
        • listSubnets
        • move
        • update
      • RouteTable
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • update
      • SecurityGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • update
        • updateRule
        • updateRules
      • Subnet
        • Overview
        • addCidrBlocks
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • removeCidrBlocks
        • update
      • Operation
        • Overview
        • get
    • gRPC
      • Overview
      • AddressService
      • GatewayService
      • NetworkService
      • RouteTableService
      • SecurityGroupService
      • SubnetService
      • OperationService
  • Questions and answers
  1. API reference
  2. REST
  3. Address
  4. getByValue

Virtual Private Cloud API, REST: Address.getByValue

Written by
Yandex Cloud
  • HTTP request
  • Query parameters
  • Response

Returns the specified Address resource by a given value.

To get the list of all available Address resources, make a list request.

HTTP request

GET https://vpc.api.cloud.yandex.net/vpc/v1/addresses:byValue

Query parameters

Parameter Description
externalIpv4Address

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "reserved": true,
  "used": true,
  "type": "string",
  "ipVersion": "string",
  "deletionProtection": true,
  "externalIpv4Address": {
    "address": "string",
    "zoneId": "string",
    "requirements": {
      "ddosProtectionProvider": "string",
      "outgoingSmtpCapability": "string"
    }
  }
}

An Address resource. For more information, see Address.

Field Description
id string

ID of the address. Generated at creation time.

folderId string

ID of the folder that the address belongs to.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name string

Name of the address. The name is unique within the folder.

description string

Description of the address.

labels object

Resource labels as key:value pairs.

reserved boolean (boolean)

Specifies if address is reserved or not.

used boolean (boolean)

Specifies if address is used or not.

type string
Type of the IP address.
  • INTERNAL: Internal IP address.
  • EXTERNAL: Public IP address.
ipVersion string
Vervion of the IP address.
  • IPV4: IPv4 address.
  • IPV6: IPv6 address.
deletionProtection boolean (boolean)

Specifies if address protected from deletion.

externalIpv4Address object
externalIpv4Address.
address
string

Value of address.

externalIpv4Address.
zoneId
string

Availability zone from which the address will be allocated.

externalIpv4Address.
requirements
object

Parameters of the allocated address, for example DDoS Protection.

externalIpv4Address.
requirements.
ddosProtectionProvider
string

DDoS protection provider ID.

externalIpv4Address.
requirements.
outgoingSmtpCapability
string

Capability to send SMTP traffic.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Query parameters
  • Response