Skip to content

ip_release_request

Browse IP release requests

Index

Path
GET /v7.0/ip_release_requests
Description
Authentication required
yes
Scope
ip_release_request#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
ip_release_request
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
ip_release_campaign
IP release campaign
 Resource no

Output parameters

Layout
object_list
Namespace
ip_release_requests
ParameterTypeDescription
id
ID
 Integer
ip_release_campaign
IP release campaign
 Resource
user
User
 Resource
original_user_id
Original user ID
 Integer
user_login
User login
 String
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
can_keep
Can keep addresses
 Boolean
can_assign
Can assign addresses
 Boolean
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
closed_at
Closed at
 Datetime
notified_at
Last notice queued
 Datetime
mail_log
Last notice
 Resource

Keep

Path
POST /v7.0/ip_release_requests/{ip_release_request_id}/keep
Description
Keep selected IP addresses with a reason
Authentication required
yes
Scope
ip_release_request#keep
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
ip_release_request
ParameterTypeRequiredDetails
addresses
IP addresses
 Custom yes

Array of request address IDs

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
reason
Reason
 Text yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
ip_release_request
ParameterTypeDescription
id
ID
 Integer
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
can_keep
Can keep addresses
 Boolean
can_assign
Can assign addresses
 Boolean

Show

Path
GET /v7.0/ip_release_requests/{ip_release_request_id}
Description
Authentication required
yes
Scope
ip_release_request#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
ip_release_request
ParameterTypeDescription
id
ID
 Integer
ip_release_campaign
IP release campaign
 Resource
user
User
 Resource
original_user_id
Original user ID
 Integer
user_login
User login
 String
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
can_keep
Can keep addresses
 Boolean
can_assign
Can assign addresses
 Boolean
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
closed_at
Closed at
 Datetime
notified_at
Last notice queued
 Datetime
mail_log
Last notice
 Resource

Subresources