Skip to main content
GET
/
network
/
reserved_ips
/
{reserved_ip_id}
Get a specific reserved IP
curl --request GET \
  --url https://api.cloud.onidel.com/network/reserved_ips/{reserved_ip_id} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "location": "<string>",
  "status": "active",
  "billing_cycle": 123,
  "renewal_date": "2023-11-07T05:31:56Z",
  "last_renewal": "2023-11-07T05:31:56Z",
  "recurring_amount": 123,
  "currency": "<string>",
  "total_billed": 123,
  "ip_addr": "127.0.0.1",
  "suspension_reason": "<string>",
  "attachment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Provide the value as: Token <your-api-token>

Path Parameters

​
reserved_ip_id
string<uuid>
required

Reserved IP ID

Example:

"d3c0dc7b-6ca4-4b35-8f3c-a00adc3993d5"

Query Parameters

​
team_id
string<uuid>

Team ID to verify ownership. If not provided, uses the user's primary team

Response

Reserved IP details

​
id
string<uuid>
required

Reserved IP UUID

​
name
string
required

Name of the reserved IP

​
location
string
required

Location name where the IP is allocated

​
status
enum<string>
required

Current status of the reserved IP

Available options:
active,
suspended
​
billing_cycle
integer
required

Billing cycle in months

​
renewal_date
string<date-time>
required

Next renewal date

​
last_renewal
string<date-time>
required

Last renewal date

​
recurring_amount
number<decimal>
required

Recurring billing amount

​
currency
string
required

Currency code for billing

​
total_billed
number<decimal>
required

Total amount billed

​
ip_addr
string<ipv4>
required

The reserved IP address

​
suspension_reason
string
required

Reason for suspension (empty string if not suspended)

​
attachment
object

VM attachment details, null if not attached