Page History

...

URL

/api/v1/api.php?target=resource&action=delete

Description

Delete a resource.

Returns

Examples:
SUCCESSFUL: {"success":1,"message":"Resource deleted."}
ERROR: {"success":0,"message":"No resource found with ID: 57"}

Required Parameters

Name	Type	Notes/Example
id	INTEGER	ID of the resource

Optional Parameters

Name	Type	Notes/Example
recursive	BOOL	When 1, deletes parent and child entries for the resource

A recursive delete will delete all resources, which are permitted to be deleted, from the bottom up.

Imagine the following hierarchy:

Code Block
A B1 B2 C11 C12 C21 C22

If a recursive delete is performed on A, but C21 is not deletable, the following

resources would still be deleted: (B1, C11, C12, C22).

B2 would not be deleted because it depends on C21 and A would not be deleted because it depends on B2.

Example URL

/api/v1/api.php?target=resource&action=delete&id=57

Description

Get available resource links. If no resource links exist for the given resource, an empty object is returned.

URL

/api/v1/api.php?target=resource&action=getLink

Returns

Examples:

SUCCESSFUL:	{"success":1 ,"message":"Search successful", "data":{"meta":{"totalRecords":"3", "retrieved":3}, "0":{"id":"22", "resource_id1":"1292", "resource_id2":"1302", "relation":"dhcpPoolLink"}, "1":{"id":"2", "resource_id1":"1292", "resource_id2":"1452", "relation":"dhcpPoolLink"}, "2":{"id":"12", "resource_id1":"1422", "resource_id2":"1482", "relation":"dhcpPoolLink"}}}
ERROR:	{"success":0, "message":"error message"}

Return Detail:

Name	Type	Description
id	INTEGER	Id of the resource linkage
resource_id1	INTEGER	The id of the parent resource
resource_id2	INTEGER	The id of the linked resource
relation	STRING	The relation type. Relation types include: contact, dhcpPoolLink, dnsViewACL, dnsViewServer, dnsZoneMaster, dnsZoneServer, dnsZoneView

Meta Attributes:

Name	Type	Description
totalRecords	INTEGER	How many records were found by this query, without pagination.
retrieved	INTEGER	How many records were returned by this query, with pagination.

Optional Attributes:

Name	Type	Description
resultsPerPage	INTEGER	How many records to include per page display.*
page	INTEGER	Which page to display, when used with "resultsPerPage"*
*Example pagination: api.php?target=resource&action=getLink&relation=dhcpPoolLink&resultsPerPage=100&page=2

Page tree