LIR Management
Warning |
---|
ProVision's APIv1 system has been replaced by APIv2, and is now considered deprecated. |
Table of Contents |
---|
HTML |
---|
<div id="google_translate_element"></div>
<script type="text/javascript">
function googleTranslateElementInit() {
new google.translate.TranslateElement({pageLanguage: 'en'}, 'google_translate_element');
}
</script>
<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script> |
Table of Contents |
---|
...
Get | |||||
---|---|---|---|---|---|
URL | /api/v1/api.php?target=lir&action=get | ||||
Description | Returns a list of LIRs | ||||
Returns | Examples:
| ||||
Example URL | /api/v1/api.php?target=lir&action=get |
...
Add | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=lir&action=add | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Adds a new LIR. LIR creation utilizes the Resource system - see API Module - Resource - Add for details on adding a resource via the API. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters ( meta[ ] =) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fields Information |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters ( fields[ ][] =) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters ( fields[ ][] =) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | ARIN example with only minimum required information: /api/v1/api.php?target=lir&action=add&meta[name]=TestLIR1&meta[type]=entry&meta[section]=lir&fields[rir][]=ARIN&fields[asn][]=20202 ARIN example with full Organization field details: /api/v1/api.php?target=lir&action=add&meta[name]=TestLIR2&meta[type]=entry&meta[section]=lir&fields[rir][]=ARIN&fields[asn][]=20202&fields[org-handle][]=org1&fields[admin-poc][]=admin1&fields[net-poc][]=tech1&fields[abuse-poc][]=abuse1&fields[net-name-prefix][]=test-&fields[api-key][]=akakakakakaka Non-ARIN example with only minimum required information: /api/v1/api.php?target=lir&action=add&meta[name]=TestLIR3&meta[type]=entry&meta[section]=lir&fields[rir][]=RIPE&fields[asn][]=20202 Non-ARIN example with full Organization field details: /api/v1/api.php?target=lir&action=add&meta[name]=TestLIR4&meta[type]=entry&meta[section]=lir&fields[rir][]=1918&fields[asn][]=20202&fields[mnt-by][]=maint1&fields[mnt-by-password][]=passwordabcd&fields[admin-c][]=admin1&fields[tech-c][]=tech1 |
...
Update | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=lir&action=update | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Updates a LIR. LIR updates utilize the Resource system - see API Module - Resource - Update for details on editing a resource via the API. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters ( meta[ ] =) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters ( meta[ ] =) |
| | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters ( fields[ ][] =) | None.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters ( fields[ ][] =) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | Update example with only the minimum required information: This sends only the meta data required for a success response, but it does not actually change any values. /api/v1/api.php?target=lir&action=update&meta[id]=14068&meta[type]=entry Update example with changing RIR, ASN, and updating all field information: This example changes a non-ARIN LIR to an ARIN LIR, and provides all updated information for the new RIR type. /api/v1/api.php?target=lir&action=update&meta[id]=14068&meta[type]=entry&meta[name]=TestLIR4b&fields[rir][]=ARIN&fields[asn][]=30303&fields[org-handle][]=OrgABC&fields[admin-poc][]=AdminABC&fields[tech-c][]=TechABC&fields[abuse-poc][]=AbuseABC&fields[net-name-prefix][]=TestABC-&fields[api-key][]=abcdabcd |
...