Get started
Yandex Virtual Private Cloud

Virtual Private Cloud API, REST: Address.getByValue

Written by

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.
In this article: