Skip to content

ip_release_request.address

Browse IP addresses in a release request

Exempt

Path
POST /v7.0/ip_release_requests/{ip_release_request_id}/addresses/{address_id}/exempt
Description
Set an admin exemption with a reason, or remove it by passing a null reason
Authentication required
yes
Scope
ip_release_request.address#exempt
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
address
ParameterTypeRequiredDetails
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
address
ParameterTypeDescription
id
ID
 Integer
ip_address
IP address
 Resource
assign_ip_address_id
Address available for assignment
 Integer
address
IP address
 String
location_label
Location
 String
original_user_id
Original user ID
 Integer
user_login
User login
 String
prefix
Prefix
 Integer
size
Allocation size
 Integer
protection
Current status
 String
keep_reason
User reason
 Text
kept_at
Reason submitted at
 Datetime
kept_by_id
Reason author ID
 Integer
kept_by_login
Reason author
 String
exemption_reason
Admin exemption reason
 Text
exempted_at
Exempted at
 Datetime
exempted_by_id
Exempted by ID
 Integer
exempted_by_login
Exempted by
 String
excluded_at
Excluded at
 Datetime
exclusion_reason
Exclusion reason
 String
released_at
Released at
 Datetime
cleanup_state
Cleanup state
 String
last_result
Last release result
 String
release_chain
Release transaction chain
 Resource

Index

Path
GET /v7.0/ip_release_requests/{ip_release_request_id}/addresses
Description
Authentication required
yes
Scope
ip_release_request.address#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
address
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: 500

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

Output parameters

Layout
object_list
Namespace
addresses
ParameterTypeDescription
id
ID
 Integer
ip_address
IP address
 Resource
assign_ip_address_id
Address available for assignment
 Integer
address
IP address
 String
location_label
Location
 String
original_user_id
Original user ID
 Integer
user_login
User login
 String
prefix
Prefix
 Integer
size
Allocation size
 Integer
protection
Current status
 String
keep_reason
User reason
 Text
kept_at
Reason submitted at
 Datetime
kept_by_id
Reason author ID
 Integer
kept_by_login
Reason author
 String
exemption_reason
Admin exemption reason
 Text
exempted_at
Exempted at
 Datetime
exempted_by_id
Exempted by ID
 Integer
exempted_by_login
Exempted by
 String
excluded_at
Excluded at
 Datetime
exclusion_reason
Exclusion reason
 String
released_at
Released at
 Datetime
cleanup_state
Cleanup state
 String
last_result
Last release result
 String
release_chain
Release transaction chain
 Resource