Skip to content

ip_release_campaign

Manage IP release campaigns

Candidates

Path
GET /v7.0/ip_release_campaigns/candidates
Description
Preview unassigned owned IP addresses for a release campaign
Authentication required
yes
Scope
ip_release_campaign#candidates
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
ip_release_campaign
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
versions
IP versions
 String no

Comma-separated IP versions: 4, 6, or both

Default: 4
networks
Networks
 String no

Comma-separated network IDs; empty selects all networks

Default: ""
locations
Locations
 String no

Comma-separated location IDs; empty selects all locations

Default: ""
access
Access
 String no

Default: public_access

Validation rules
RuleDetails
Include

Allowed values:

  • public_access
  • private_access
  • all

Validation error message: %{value} cannot be used
user
User
 Resource no

Output parameters

Layout
object_list
Namespace
ip_release_campaigns
ParameterTypeDescription
id
ID
 Integer
addr
IP address
 String Address itself
prefix
Prefix
 Integer
size
Allocation size
 Integer
user
User
 Resource
network
Network
 Resource

Close

Path
POST /v7.0/ip_release_campaigns/{ip_release_campaign_id}/close
Description
Close an IP release campaign
Authentication required
yes
Scope
ip_release_campaign#close
Aliases
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeDescription
id
ID
 Integer
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
created_at
Created at
 Datetime
closed_at
Closed at
 Datetime
created_by
Created by
 Resource
closed_by
Closed by
 Resource

Create

Path
POST /v7.0/ip_release_campaigns
Description
Authentication required
yes
Scope
ip_release_campaign#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeRequiredDetails
deadline
Planned release date
 Datetime no

Advisory date for releasing unused IP addresses

Default: null
allow_keep
Allow user opt-outs
 Boolean no

Honor user reasons when deciding which IPs to release

Default: true

Validation rules
RuleDetails
Include

Allowed values:

  • true
  • false

Validation error message: %{value} cannot be used
addresses
IP addresses
 Custom yes

Array of IP address IDs from the preview

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_campaign
ParameterTypeDescription
id
ID
 Integer
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
created_at
Created at
 Datetime
closed_at
Closed at
 Datetime
created_by
Created by
 Resource
closed_by
Closed by
 Resource

Exempt

Path
POST /v7.0/ip_release_campaigns/{ip_release_campaign_id}/exempt
Description
Set or remove an administrator exemption for selected campaign addresses
Authentication required
yes
Scope
ip_release_campaign#exempt
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
ip_release_campaign
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 no

Default: null
remove
Remove exemption
 Boolean no

Default: false

Output parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeDescription
id
ID
 Integer
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
created_at
Created at
 Datetime
closed_at
Closed at
 Datetime
created_by
Created by
 Resource
closed_by
Closed by
 Resource

Index

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

Input parameters

Layout
object
Namespace
ip_release_campaign
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
open
Open
 Boolean no

Default: null

Output parameters

Layout
object_list
Namespace
ip_release_campaigns
ParameterTypeDescription
id
ID
 Integer
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
created_at
Created at
 Datetime
closed_at
Closed at
 Datetime
created_by
Created by
 Resource
closed_by
Closed by
 Resource
total_ip_count
Total IPs
 Integer All allocations recorded in the campaign, including historical rows
to_release_ip_count
IPs to be released
 Integer Eligible allocations in an open campaign and releases in progress
kept_ip_count
Kept IPs
 Integer Allocations protected by assignment, service use, exemptions or reasons honored under the current policy

Notify

Path
POST /v7.0/ip_release_campaigns/{ip_release_campaign_id}/notify
Description
Send IP release notices
Authentication required
yes
Scope
ip_release_campaign#notify
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeRequiredDetails
event
Notice type
 String no

Default: requested

Validation rules
RuleDetails
Include

Allowed values:

  • requested
  • reminder

Validation error message: %{value} cannot be used

Output parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeDescription
id
ID
 Integer
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
created_at
Created at
 Datetime
closed_at
Closed at
 Datetime
created_by
Created by
 Resource
closed_by
Closed by
 Resource

Release

Path
POST /v7.0/ip_release_campaigns/{ip_release_campaign_id}/release
Description
Release all eligible IP addresses in this campaign now
Authentication required
yes
Scope
ip_release_campaign#release
Aliases
Blocking
yes

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeDescription
id
ID
 Integer
created_at
Created at
 Datetime
created_by_id
Started by ID
 Integer
created_by_login
Started by
 String
ip_count
IP count
 Integer
state
State
 String
error
Preparation error
 Text
blocked_resource
Busy resource
 String
blocked_resource_id
Busy resource ID
 Integer
blocked_chain_id
Blocking transaction chain ID
 Integer
transaction_chain
Transaction chain
 Resource

Show

Path
GET /v7.0/ip_release_campaigns/{ip_release_campaign_id}
Description
Authentication required
yes
Scope
ip_release_campaign#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeDescription
id
ID
 Integer
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
created_at
Created at
 Datetime
closed_at
Closed at
 Datetime
created_by
Created by
 Resource
closed_by
Closed by
 Resource
total_ip_count
Total IPs
 Integer All allocations recorded in the campaign, including historical rows
to_release_ip_count
IPs to be released
 Integer Eligible allocations in an open campaign and releases in progress
kept_ip_count
Kept IPs
 Integer Allocations protected by assignment, service use, exemptions or reasons honored under the current policy
can_send_initial_notices
Can send initial notices
 Boolean
can_send_reminders
Can send reminders
 Boolean
can_release
Can release
 Boolean
latest_release_attempt
Latest release attempt
 Resource

Update

Path
PUT /v7.0/ip_release_campaigns/{ip_release_campaign_id}
Description
Authentication required
yes
Scope
ip_release_campaign#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeRequiredDetails
deadline
Planned release date
 Datetime no

Advisory date for releasing unused IP addresses

Default: null
allow_keep
Allow user opt-outs
 Boolean no

Honor user reasons when deciding which IPs to release

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • true
  • false

Validation error message: %{value} cannot be used

Output parameters

Layout
object
Namespace
ip_release_campaign
ParameterTypeDescription
id
ID
 Integer
deadline
Planned release date
 Datetime Advisory date for releasing unused IP addresses
allow_keep
Allow user opt-outs
 Boolean Honor user reasons when deciding which IPs to release
created_at
Created at
 Datetime
closed_at
Closed at
 Datetime
created_by
Created by
 Resource
closed_by
Closed by
 Resource

Subresources