Find interfaces by searching criteria

GET 
/v1/projects/:projectId/zones/:zoneName/virtualmachines/:virtualMachineId/interfaces

Return interfaces that match all searching criteria.

Request

Path Parameters

projectId stringrequired

Project Identifier

zoneName stringrequired

Zone name

virtualMachineId stringrequired

Virtual machine Identifier

Query Parameters

name string

Name of the resource.

offset int32
Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.
Default value: 0
limit int32
Possible values: >= 1
Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).
Default value: 100
sort string

Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

X-API-KEY string

Your SIU token if you use this API through Orange Developer.

Authorization string

Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

X-Requester-Id string

Your SIU Id if you use this API through Orange Developer Inside.

Responses

200

Ok

Response Headers

X-Total-Count

Returns Pagination of response. The total number of items in the collection, after application of filters if any.

X-Result-Count

The actual number of items contained in the response body. Note that it can be less than the requested "limit".

application/json

Schema

Schema

Array [
namestringrequired
Name of the interface.
Possible values: non-empty and <= 40 characters
descriptionstring
Interface description
hRefstringrequired
Hypertext reference to the Interface details.
enabledboolean
Enable the interface. The interface can be disabled/enabled by updating this parameter or by using the disable/enable actions. By default, the interface is enabled.
Default value: true
virtualNetworkRef object
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
iduuid
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
namestring
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
hRefuri
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
sharedVirtualNetworkNamestring
Name of the shared Virtual Network connected to the interface.
Possible values: non-empty and <= 50 characters, Value must match regular expression [a-zA-Z0-9-_ ]
ipAddresses object[]required
List of the IP addresses of the interface.
Possible values: >= 1
Array [
ipAddressstringrequired
IP address.
Possible values: Value must match regular expression ^(?:(?:(?:1\d{2}|[1-9]?\d|2[0-4]\d|25[0-5])(?:\.(?!$)|$)){4})|(?:(?:(?:[a-f1-9A-F][a-fA-F\d]{1,3}|[a-fA-F\d])(?::(?!$)|$)){8})$
familyIpFamilyEnum (string)
IP Family Enum (ipv6 not available yet).
Possible values: [ipv4, ipv6]
isIpLocalboolean
Scope of the IP address:
• "true": the IP address cannot be routed outside the local network (NB: not compatible with BGPaaS)
• "false": the IP address can be routed outside the local network
Default value: false
]
floatingIpAddressstring
The floating IP is used to configure 1-to-1 NAT on the subinterface. This parameter specifies the Public IP address to use for NAT. Ipv4 only available for the moment.
floatingPrivateIpAddressstring
Fixed IP address mapped to the public IP address used as floating IP
securityGroupRefs object[]
List of the Security Groups to apply on the interface.
Array [
iduuid
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
namestring
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
hRefuri
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
]
allowedIpAddressPairs object[]
VRRP feature to define VIP IP
Array [
ipAddressstringrequired
Virtual IP address.
modeAddressPairModeEnum (string)
VRRP mode.
Possible values: [active-active, active-standby]
macAddressstring
MAC address associated to the Virtual IP address. If not provided, the MAC address of the active interface will be used.
Possible values: Value must match regular expression ^[\da-fA-F]{2}(?:-[\da-fA-F]{2}){5}$
]
macAddressstring
Mac address of the interface. Only Unicast MAC addresses are accepted. If not provided, the MAC address will be calculated automatically from a md5 hash of the interface name.
Possible values: Value must match regular expression ^[\da-fA-F][02468aACEce](?:-[\da-fA-F]{2}){5}$
interfaceRoutes object[]
Interface loopback prefixe(s) and attributes to advertise.
Array [
prefixstringrequired
Subnet in CIDR format.
communityTagsstring[]
Community Tags. Possible values: community tag or 'no-export', 'no-advertise'
Possible values: <= 10
]
subInterfaces object[]
Subinterfaces supported on the interface.
Array [
namestringrequired
Name of the subinterface. Must be unique for the interface. This attribute can not be updated.
Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]
descriptionstring
Subinterface description.
Possible values: <= 100 characters, Value must match regular expression ^[ -Za-zà-ë_]
enabledboolean
Enable the subinterface. The interface can be disabled/enabled by updating this parameter.
Default value: true
virtualNetworkRef object
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
iduuid
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
namestring
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
hRefuri
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
sharedVirtualNetworkNamestring
Name of the shared Virtual Network connected to the sub-interface. If not provided, a virtual network ref must be provided. This attribute can not be updated.
Possible values: non-empty and <= 50 characters, Value must match regular expression [a-zA-Z0-9-_ ]
vlanIdint32required
802.1Q VLAN tag (range [100-199] recommended). This attribute can not be updated.
ipAddresses object[]required
List of the IP addresses of the subinterface.
Array [
ipAddressstringrequired
IP address.
Possible values: Value must match regular expression ^(?:(?:(?:1\d{2}|[1-9]?\d|2[0-4]\d|25[0-5])(?:\.(?!$)|$)){4})|(?:(?:(?:[a-f1-9A-F][a-fA-F\d]{1,3}|[a-fA-F\d])(?::(?!$)|$)){8})$
familyIpFamilyEnum (string)
IP Family Enum (ipv6 not available yet).
Possible values: [ipv4, ipv6]
isIpLocalboolean
Scope of the IP address:
• "true": the IP address cannot be routed outside the local network (NB: not compatible with BGPaaS)
• "false": the IP address can be routed outside the local network
Default value: false
]
floatingIpAddressstring
The floating IP is used to configure 1-to-1 NAT on the subinterface. This parameter specifies the Public IP address to use for NAT. This attribute can not be updated. IpV6 not available yet.
floatingPrivateIpAddressstring
The floating IP is used to configure 1-to-1 NAT on the subinterface. This parameter specifies the Private IP address to use for NAT in case multiple IP addresses have been configured (this is recommended in this case, otherwise the private IP address will be selected randomly). IpV6 not available yet.
securityGroupRefs object
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
iduuid
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
namestring
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
hRefuri
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
allowedIpAddressPairs object[]
List of Virtual IP addresses (VRRP protocol).
Array [
ipAddressstringrequired
Virtual IP address.
modeAddressPairModeEnum (string)
VRRP mode.
Possible values: [active-active, active-standby]
macAddressstring
MAC address associated to the Virtual IP address. If not provided, the MAC address of the active interface will be used.
Possible values: Value must match regular expression ^[\da-fA-F]{2}(?:-[\da-fA-F]{2}){5}$
]
macAddressstring
Mac address of the subinterface. Only Unicast MAC addresses are accepted. If not provided, the MAC address will be calculated automatically from a md5 hash of the subinterface name.
Possible values: Value must match regular expression ^[\da-fA-F][02468aACEce](?:-[\da-fA-F]{2}){5}$
interfaceRoutes object[]
Subinterface loopback prefixe(s) and attributes to advertise.
Array [
prefixstringrequired
Subnet in CIDR format.
communityTagsstring[]
Community Tags. Possible values: community tag or 'no-export', 'no-advertise'
Possible values: <= 10
]
bgpaas object
BGPAAS option
autonomousSystemint32required
Peer Autonomous System (2 or 4 bytes). Modifying it will cause a BGP flap.
adminSessionStateAdminSessionStateEnum (string)
Bgpaas session admin state.
Possible values: [up, down]
asOverrideboolean
AS override replaces all occurrences of the peer ASN in the AS-path with the system AS. NB: This is a tricky option, do not use without prior knowledge.
localAutonomousSystemint32
Local Autonomous System used for this particular session. If configured, this overrides the backbone Autonomous System. Modifying it will cause a BGP flap.
bgpAddressFamiliesBGPAddressFamilyEnum (string)[]
List of BGP address families supported on this session (v6 is implemented according to RFC 2545). By default, this list contains only "inet"
Possible values: [inet, inet6]
maxRoutesint32
Maximum number of BGP routes allowed by the BGPaaS session. This attribute can not be updated.
Default value: 10000
loopCountint32
Allows the vRouter to accept its own AS system in the AS path, a certain number of times defined by the loop count.
Possible values: <= 3
Default value: 0
holdTimeint32
BGP hold time (standard BGP) (seconds). Max time to detect liveliness of peer.
Possible values: >= 45 and <= 65535
Default value: 60
]
bgpaas object
BGPAAS option
autonomousSystemint32required
Peer Autonomous System (2 or 4 bytes). Modifying it will cause a BGP flap.
adminSessionStateAdminSessionStateEnum (string)
Bgpaas session admin state.
Possible values: [up, down]
asOverrideboolean
AS override replaces all occurrences of the peer ASN in the AS-path with the system AS. NB: This is a tricky option, do not use without prior knowledge.
localAutonomousSystemint32
Local Autonomous System used for this particular session. If configured, this overrides the backbone Autonomous System. Modifying it will cause a BGP flap.
bgpAddressFamiliesBGPAddressFamilyEnum (string)[]
List of BGP address families supported on this session (v6 is implemented according to RFC 2545). By default, this list contains only "inet"
Possible values: [inet, inet6]
maxRoutesint32
Maximum number of BGP routes allowed by the BGPaaS session. This attribute can not be updated.
Default value: 10000
loopCountint32
Allows the vRouter to accept its own AS system in the AS path, a certain number of times defined by the loop count.
Possible values: <= 3
Default value: 0
holdTimeint32
BGP hold time (standard BGP) (seconds). Max time to detect liveliness of peer.
Possible values: >= 45 and <= 65535
Default value: 60
]

Example (auto)

[
  {
    "name": "string",
    "description": "string",
    "hRef": "string",
    "enabled": true,
    "virtualNetworkRef": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "hRef": "string"
    },
    "sharedVirtualNetworkName": "string",
    "ipAddresses": [
      {
        "ipAddress": "string",
        "family": "ipv4",
        "isIpLocal": false
      }
    ],
    "floatingIpAddress": "string",
    "floatingPrivateIpAddress": "string",
    "securityGroupRefs": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "hRef": "string"
      }
    ],
    "allowedIpAddressPairs": [
      {
        "ipAddress": "string",
        "mode": "active-active",
        "macAddress": "string"
      }
    ],
    "macAddress": "string",
    "interfaceRoutes": [
      {
        "prefix": "string",
        "communityTags": [
          "string"
        ]
      }
    ],
    "subInterfaces": [
      {
        "name": "string",
        "description": "string",
        "enabled": true,
        "virtualNetworkRef": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "hRef": "string"
        },
        "sharedVirtualNetworkName": "string",
        "vlanId": 0,
        "ipAddresses": [
          {
            "ipAddress": "string",
            "family": "ipv4",
            "isIpLocal": false
          }
        ],
        "floatingIpAddress": "string",
        "floatingPrivateIpAddress": "string",
        "securityGroupRefs": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "hRef": "string"
        },
        "allowedIpAddressPairs": [
          {
            "ipAddress": "string",
            "mode": "active-active",
            "macAddress": "string"
          }
        ],
        "macAddress": "string",
        "interfaceRoutes": [
          {
            "prefix": "string",
            "communityTags": [
              "string"
            ]
          }
        ],
        "bgpaas": {
          "autonomousSystem": 0,
          "adminSessionState": "up",
          "asOverride": true,
          "localAutonomousSystem": 0,
          "bgpAddressFamilies": [
            "inet"
          ],
          "maxRoutes": 10000,
          "loopCount": 0,
          "holdTime": 60
        }
      }
    ],
    "bgpaas": {
      "autonomousSystem": 0,
      "adminSessionState": "up",
      "asOverride": true,
      "localAutonomousSystem": 0,
      "bgpAddressFamilies": [
        "inet"
      ],
      "maxRoutes": 10000,
      "loopCount": 0,
      "holdTime": 60
    }
  }
]

400

Bad Request

Request is not valid

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

Not Found

Unknown resource or service

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

405

Method Not Allowed

Operation is not valid according to the state of the resource

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L '/v1/projects/:projectId/zones/:zoneName/virtualmachines/:virtualMachineId/interfaces' \
-H 'Accept: application/json'

Request Collapse all

Base URL

/v1

Parameters

projectId — pathrequired

zoneName — pathrequired

virtualMachineId — pathrequired

name — query

offset — query

limit — query

sort — query

X-API-KEY — header

Authorization — header

X-Requester-Id — header