Contact usConsole
© 2023 Nebius Israel Ltd
Compute Cloud

Compute Cloud API, REST: Instance.updateNetworkInterface

Updates the specified instance network interface.

HTTP request

PATCH https://compute.api.il.nebius.cloud/compute/v1/instances/{instanceId}/updateNetworkInterface

Path parameters

Parameter Description
instanceId

Required. ID of the network interface that is being updated.

Body parameters

{
  "networkInterfaceIndex": "string",
  "updateMask": "string",
  "subnetId": "string",
  "primaryV4AddressSpec": {
    "address": "string",
    "oneToOneNatSpec": {
      "ipVersion": "string",
      "address": "string",
      "dnsRecordSpecs": [
        {
          "fqdn": "string",
          "dnsZoneId": "string",
          "ttl": "string",
          "ptr": true
        }
      ]
    },
    "dnsRecordSpecs": [
      {
        "fqdn": "string",
        "dnsZoneId": "string",
        "ttl": "string",
        "ptr": true
      }
    ]
  },
  "primaryV6AddressSpec": {
    "address": "string",
    "oneToOneNatSpec": {
      "ipVersion": "string",
      "address": "string",
      "dnsRecordSpecs": [
        {
          "fqdn": "string",
          "dnsZoneId": "string",
          "ttl": "string",
          "ptr": true
        }
      ]
    },
    "dnsRecordSpecs": [
      {
        "fqdn": "string",
        "dnsZoneId": "string",
        "ttl": "string",
        "ptr": true
      }
    ]
  },
  "securityGroupIds": [
    "string"
  ]
}
Field Description
networkInterfaceIndex string

Required. The index of the network interface to be updated.
updateMask string

Field mask that specifies which attributes of the instance should be updated.

A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in updateMask and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
subnetId string

ID of the subnet.
primaryV4AddressSpec object

Primary IPv4 address that will be assigned to the instance for this network interface.
primaryV4AddressSpec.
address		 string

An IPv4 internal network address that is assigned to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
primaryV4AddressSpec.
oneToOneNatSpec		 object

An external IP address configuration. If not specified, then this instance will have no external internet access.
primaryV4AddressSpec.
oneToOneNatSpec.
ipVersion		 string

External IP address version.

  • IPV4: IPv4 address, for example 192.0.2.235.
  • IPV6: IPv6 address. Not available yet.
primaryV4AddressSpec.
oneToOneNatSpec.
address		 string
primaryV4AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[]		 object

External DNS configuration
primaryV4AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[].
fqdn		 string

Required. FQDN (required)
primaryV4AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[].
dnsZoneId		 string

DNS zone id (optional, if not set, private zone used)
primaryV4AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[].
ttl		 string (int64)

DNS record ttl, values in 0-86400 (optional)

Acceptable values are 0 to 86400, inclusive.
primaryV4AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[].
ptr		 boolean (boolean)

When set to true, also create PTR DNS record (optional)
primaryV4AddressSpec.
dnsRecordSpecs[]		 object

Internal DNS configuration
primaryV4AddressSpec.
dnsRecordSpecs[].
fqdn		 string

Required. FQDN (required)
primaryV4AddressSpec.
dnsRecordSpecs[].
dnsZoneId		 string

DNS zone id (optional, if not set, private zone used)
primaryV4AddressSpec.
dnsRecordSpecs[].
ttl		 string (int64)

DNS record ttl, values in 0-86400 (optional)

Acceptable values are 0 to 86400, inclusive.
primaryV4AddressSpec.
dnsRecordSpecs[].
ptr		 boolean (boolean)

When set to true, also create PTR DNS record (optional)
primaryV6AddressSpec object

Primary IPv6 address that will be assigned to the instance for this network interface. IPv6 not available yet.
primaryV6AddressSpec.
address		 string

An IPv4 internal network address that is assigned to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
primaryV6AddressSpec.
oneToOneNatSpec		 object

An external IP address configuration. If not specified, then this instance will have no external internet access.
primaryV6AddressSpec.
oneToOneNatSpec.
ipVersion		 string

External IP address version.

  • IPV4: IPv4 address, for example 192.0.2.235.
  • IPV6: IPv6 address. Not available yet.
primaryV6AddressSpec.
oneToOneNatSpec.
address		 string
primaryV6AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[]		 object

External DNS configuration
primaryV6AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[].
fqdn		 string

Required. FQDN (required)
primaryV6AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[].
dnsZoneId		 string

DNS zone id (optional, if not set, private zone used)
primaryV6AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[].
ttl		 string (int64)

DNS record ttl, values in 0-86400 (optional)

Acceptable values are 0 to 86400, inclusive.
primaryV6AddressSpec.
oneToOneNatSpec.
dnsRecordSpecs[].
ptr		 boolean (boolean)

When set to true, also create PTR DNS record (optional)
primaryV6AddressSpec.
dnsRecordSpecs[]		 object

Internal DNS configuration
primaryV6AddressSpec.
dnsRecordSpecs[].
fqdn		 string

Required. FQDN (required)
primaryV6AddressSpec.
dnsRecordSpecs[].
dnsZoneId		 string

DNS zone id (optional, if not set, private zone used)
primaryV6AddressSpec.
dnsRecordSpecs[].
ttl		 string (int64)

DNS record ttl, values in 0-86400 (optional)

Acceptable values are 0 to 86400, inclusive.
primaryV6AddressSpec.
dnsRecordSpecs[].
ptr		 boolean (boolean)

When set to true, also create PTR DNS record (optional)
securityGroupIds[] string

ID's of security groups attached to the interface.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.
description string

Description of the operation. 0-256 characters long.
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).
createdBy string

ID of the user or service account who initiated the operation.
modifiedAt string (date-time)

The time when the Operation resource was last modified.

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).
done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
error.
message		 string

An error message.
error.
details[]		 object

A list of messages that carry the error details.
response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.
© 2023 Nebius Israel Ltd
In this article: