add |
|---|
| URL | /api/v1/api.php?target=resource&action=add |
| Description | Add a resource. |
| Returns | Examples: /api/v1/api.php?target=resource&action=add&meta[name]=apitest&meta[type]=entry&meta[section]=firewall&fields[network-fqdn][]=www.example.com SUCCESSFUL: {"success":1,"message":"Resource added","data":{"id":1077,"name":"apitest","slug":"apitest","type":"entry","parent_id":1,"category_id":"NULL","attr":{"_section":"70","network-fqdn":"www.example.com"},"section":{"id":"70","name":"Firewall","slug":"firewall","type":"section","parent_id":"1","category_id":null,"attr":{}}}} /api/v1/api.php?target=resource&action=add&meta[name]=apitest&meta[type]=entry&fields[network-fqdn][]=www.example.com ERROR:{"success":0,"message":"Entries must be assigned to a section"} |
| Required Parameters | | Name | Type | Notes/Example |
|---|
| meta[name] | STRING | Name of the resource | | meta[type] | STRING | Type of resource (entry, section, field, ectetc.) |
|
| Optional Parameters | | Name | Type | Notes/Example |
|---|
| meta[parent_id] | INTEGER | ID of the parent resource | | meta[category_id] | INTEGER | ID of the category |
|
Required Parameters (meta[type] = entry) |
One of the following: | Name | Type | Notes/Example |
|---|
| meta[section_id] | INTEGER | ID of the section that the entry will be assigned to | | meta[section] | STRING | Slug of the section that the entry will be assigned to |
|
Optional Parameters (meta[type] = entry) | | Name | Type | Notes/Example |
|---|
| fields[] | ARRAY | Entry field values (for fields that have already been assigned to the section) can be populated when the entry is created. The format is field[field-slug][field-instance]. If the field instance is left blank, it will simply be the next value in the instance array. For example: fields[network-fqdn][]=example.com&fields[network-fqdn][]=test.com would be written in JSON as var fields = { "network-fqdn": [ "example.com", "test.com" ] } Please note that the Field Slug might differ from the Field Name! To find the correct slug to use in adding resources with field values go the Section of the Resource you are adding, click 'Edit', then click the name of the Fields you will be populating. An Edit Field box will pop up which displays the Field's slug. A field can be added to a section multiple times. The field instance is used to keep track of which field occurrence we are referring. In this example, the network-fqdn field had been added twice to the section so we were able to store two values for it. | | meta[custom_id] | STRING | A custom ID for the entry. In the past this has been called the Resource Holder ID or Customer ID. Most recently it was implemented as a text field with the slug "6c-resourceholder-id." Now it is a fundamental part the entry type resources. |
|
Required Parameters (meta[type] = field) | | Name | Type | Notes/Example |
|---|
| meta[field_type] | STRING | Type of field - text
- textarea
- radios
- checkboxes
- choicebox
|
|
Optional Parameters (meta[type] = field) | | Name | Type | Notes/Example |
|---|
| meta[help_block] | STRING | Fields can have a line of text under them with instructions | | meta[options] | ARRAY | Fields of type radios, checkboxes, or choicebox can have multiple options. This could be multiple radio buttons or a choicebox (dropdown) with several options. For example: meta[type]=field&meta[name]=Colors&meta[field_type]=choicebox&meta[options][]=Blue&meta[options][]=Green Will create a choicebox with dropdown options of Blue and Green. |
|
Required Parameters (meta[type] = gadgets) | | Name | Type | Notes/Example |
|---|
| gadgets[x][uuid] | INTEGER | x: The nth gadget being described in the call ('0' for the first gadget, '1' for the second, and so on). uuid: User-generated ID of the gadget to be created. | | gadgets[x][code] | STRING | x: The nth gadget being described in the call ('0' for the first gadget, '1' for the second, and so on). code: Slug of the gadget code to be created. List of valid Gadget codes: - Contact Info: "_contact_info"
- Contacts: "_contacts"
- DHCP Server: "_dhcp_server"
- DNS: "_dns"
- Document Storage: "_document_storage"
- IPAM: "_ipam"
- Peer Groups: "_peering_peer_groups"
- Peering Sessions: "_peering_sessions"
- VRFs: "_peering_vrfs"
- Resource Linkage: "_resource_linkage"
- Resource View: "_resource_view"
- Reverse API Console: "_reverse_api"
- Tech Info: "_tech_info"
|
Example - Adding the IPAM Gadget to a Section: api.php?target=resource&action=add&meta[type]=section&meta[name]=TestSection_1&meta[parent_id]=1&gadgets[0][uuid]=uuid-586dbd260d6ef&gadgets[0][code]=_ipam |
