Core

This page documents the special methods available on Core models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint reference.

Standard API Operations

The standard endpoint methods (.all(), .filter(), .get(), .create(), .update(), .delete()) follow NetBox's REST API. Refer to the NetBox API documentation for the available fields and filters on each endpoint.

Data Sources

Sync

The sync property triggers a synchronization of the data source, enqueuing a job to fetch its files from the configured backend (e.g. git, S3).

pynetbox.models.core.DataSources.sync property readonly

Represents the sync detail endpoint.

Returns a DetailEndpoint object that is the interface for triggering a sync of the data source.

Returns

DetailEndpoint object.

Examples

data_source = nb.core.data_sources.get(123)
data_source.sync.create()

Example:

data_source = nb.core.data_sources.get(name='config-templates')
data_source.sync.create()