Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can find further documentation [here](https://github.com/netboxlabs/netbox-c

## Requirements

* NetBox v4.4-beta or later
* NetBox v4.4 or later

## Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ The response will include the created object with its assigned ID and additional

### API output in the browser

As with other NetBox objects, you can also view the API output for given Custom Objects by prepending `api/` to the URL, e.g. `api/plugins/custom-objects/dhcp_scope/`
As with other NetBox objects, you can also view the API output for given Custom Objects by prepending `api/` to the URL, e.g. `api/plugins/custom-objects/dhcp_scopes/`

```
HTTP 200 OK
Expand Down
20 changes: 12 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,18 @@ Let's walk through the above DHCP Scope example, to highlight the steps involved
### Create the Custom Object Type

1. Navigate to the Custom Objects plugin in the left navigation pane and click the `+` next to `Custom Object Types`
2. Choose a name for your Custom Object Type. In this case we will choose `dhcp_scope`
2. Choose the relevant naming for your Custom Object Type.

> [!TIP]
> Give your Custom Object Types URL friendly names
| Field | Value |
|-------------------------|---------------|
| Internal name | `dhcp_scope` |
| Display name (singular) | `DHCP Scope` |
| Display name (plural) | `DHCP Scopes` |
| URL path/slug | `dhcp_scopes` |

> [!TIP]
> By default the plural name for your Custom Object Type will be its name with `s` appended. So for example, multiple `dhcp_scope` Custom Objects will be referred to as `dhcp_scopes`.
> This behaviour can be overridden using the `Readable plural name` field. For example if you have a Custom Object Type called `Child` you can use the `Readable plural name` field to specify `Children` instead of `Childs`
> You can optionally choose a version for for your custom object type, e.g. `0.1`
> Custom Object Type versioning will become more important in future releases of NetBox Custom Objects

3. Click `Create`

Expand Down Expand Up @@ -87,15 +91,15 @@ Typically, NetBox admins would be responsible for thinking through modelling req

Now that you've created your `DHCP Scope` Custom Object Type, let's go ahead and create a new `DHCP Scope`.

1. Under the NetBox Custom Objects plugin in the left side navigation you will now see `Dhcp_scopes`. Click on `+` next to your new Custom Object Type.
1. Under the NetBox Custom Objects plugin in the left side navigation you will now see `DHCP Scopes`. Click on `+` next to your new Custom Object Type.
2. As you added a single field, called `Range` of type `IPAM > IP Range` you are prompted to specify a range. Go and ahead and select one, then click `Create`.
3. You're now taken to the detail view for your new `DHCP Scope` object.

#### Standard list views for Custom Objects

As with core NetBox objects, Custom Objects have their own list views. To see all your `DHCP Scopes` you can just click on your Custom Object Type in the Custom Object plugin section in the left side navigation. In the example above, click on `Custom Objects` -> `OBJECTS` -> `Dhcp_scopes`
As with core NetBox objects, Custom Objects have their own list views. To see all your `DHCP Scopes` you can just click on your Custom Object Type in the Custom Object plugin section in the left side navigation. In the example above, click on `Custom Objects` -> `OBJECTS` -> `DHCP Scopes`

You will now see a standard NetBox list view for your new Custom Objects with the standard options including `Configure Table`, `+ Add`, Import, Export, etc
You will now see a standard NetBox list view for your new Custom Objects with the standard options including `Configure Table`, `+ Add`, `Import`, `Export`, etc

### Deletions

Expand Down