Find IP Address

GET 
/v1/projects/:projectId/ipaddresses

Find IP Address

Request

Path Parameters

projectId stringrequired

Project 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.

zoneName string

Name of the POP

provisioningState BasicStateEnum

Possible values: [creating, updating, deleting, active, error]

provisioning state

isUsed boolean

Flag indicating if the IP address is already used on an interface of a VM

Header Parameters

Authorization string

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

X-API-KEY string

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

X-Requester-Id string

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

Responses

200

Ok

application/json

Schema

Schema

Array [
namestringrequired
Unique resource name. This attribute can not be updated.
Possible values: Value must match regular expression [A-Za-z0-9-]
descriptionstring
Resource description
tags object
Tags associated with the resource
property name*string
iduuidrequired
Resource identifier.
hRefurirequired
Hypertext reference of the resource.
createdDatedate-timerequired
Creation date of the resource.
lastModifiedDatedate-timerequired
Date of the last modification of the resource.
lastRequesterIdstringrequired
Identifier of the user of the last create/update/delete operation requested on the resource.
provisioningStateBasicStateEnum (string)required
Provisioning state of the resource. Possible state:
• creating: resource creation in progress
• updating: resource update in progress
• deleting: resource deletion in progress
• active: resource created/updated successfully
• error: resource in error because the last creation/update/deletion failed
Possible values: [active, creating, deleting, error, updating]
zonestringrequired
AZ controller commercial name
familystringrequired
IP Family Enum (ipv6 not available yet).
Possible values: [ipv4, ipv6]
Default value: ipv4
vpnNamestringrequired
Name of the shared Virtual Network
ipScopeIPScopeEnum (string)required
Scope of the IP (local or global in the VPN)
Possible values: [global, local]
ipAddressstringrequired
Allocated IP address.
isUsedbooleanrequired
Flag indicating if the IP address is already used on an interface of a VM
]

Example (auto)

[
  {
    "name": "string",
    "description": "string",
    "tags": {},
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "hRef": "string",
    "createdDate": "2024-07-29T15:51:28.071Z",
    "lastModifiedDate": "2024-07-29T15:51:28.071Z",
    "lastRequesterId": "string",
    "provisioningState": "active",
    "zone": "string",
    "family": "ipv4",
    "vpnName": "string",
    "ipScope": "global",
    "ipAddress": "string",
    "isUsed": true
  }
]

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/ipaddresses' \
-H 'Accept: application/json'

Request Collapse all

Base URL

/v1

Parameters

projectId — pathrequired

name — query

offset — query

limit — query

sort — query

zoneName — query

provisioningState — query

---creatingupdatingdeletingactiveerror

isUsed — query

---truefalse

Authorization — header

X-API-KEY — header

X-Requester-Id — header