Overview

This page discusses the functionality available via the API.

tasks

The current status of a request. Used to represent requests that may take some time to process.

entities

An ‘entity’ is a contact point, and may represent a specific person or an organizational function. Entities may be associated with a subaccount or a delegation to a subaccount. (Note that entity record data provided to the API will be mapped into Whois records and RDAP entity records, depending on the roles (‘technical’, ‘administrative’ and ‘abuse’) that are assigned to that entity.). The API supports the general management of entities (create, update, delete).

subaccounts

A subaccount is a member of an NIR. Resources can be delegated to subaccounts and transferred between them, as well as deallocated from them. Entities can also be associated with subaccounts. The API supports the general management of subaccounts (create, update, delete).

pool-delegations

A pool delegation is a delegation of INRs from APNIC to the NIR for the purposes of further delegation by the NIR. The API supports retrieving the current list of pool delegations.

(Note that the last IP pool delegations happened back in 2004: the only new pool delegations that happen today are for ASNs.)

direct-delegations

A direct delegation is a delegation of INRs from APNIC to an NIR’s subaccount. The API supports making direct delegations from APNIC’s pool to a given subaccount, as well as deallocating those delegations as required.

nir-delegations

An NIR delegation is a delegation of INRs from one of the NIR’s pool delegations to an NIR’s subaccount. The API supports NIR delegations to a given subaccount, as well as deallocating those delegations as required. (Deallocation of an NIR delegation returns the resource to the NIR’s pool.)

transfers

A transfer is a movement of INRs from one account to another. The API supports moving resources from one of an NIR’s subaccounts to another of the NIR’s subaccounts.

default-entities

The default entities are used to provide contact details for delegation in Whois and RDAP. The API supports three types of roles (administrative, technical, and abuse) for the default entities. During delegation to subaccounts, the role information will be used to set the contact details of the delegation records in Whois and RDAP.

preview

Forecasts the updates that will be made as part of a related request. These preview resources are safe: fetching a preview request does not cause the relevant updates to occur.

In the case of a preview of Whois changes, the response will have a Content-Type of text/plain, and be formatted as RPSL.

rename

Updates the name property of a subaccount. Past values aren’t accepted, so as to avoid conflating distinct subaccounts.

search

Refers to a resource that can be used to search through the link’s context and related resources.