1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. DataSource
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger

    A NetBox data source (core.datasource): a git repository, S3 bucket or local path NetBox synchronises files from.

    From the official documentation:

    A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized to NetBox by saving them in the database as data file objects.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = new netbox.DataSource("test", {
        name: "test-data-source",
        type: "git",
        sourceUrl: "https://example.com/test.git",
        enabled: true,
        ignoreRules: "*.md",
        syncInterval: 1440,
        parameters: JSON.stringify({
            branch: "main",
        }),
        description: "test-description",
    });
    
    import pulumi
    import json
    import pulumi_netbox as netbox
    
    test = netbox.DataSource("test",
        name="test-data-source",
        type="git",
        source_url="https://example.com/test.git",
        enabled=True,
        ignore_rules="*.md",
        sync_interval=1440,
        parameters=json.dumps({
            "branch": "main",
        }),
        description="test-description")
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v6/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"branch": "main",
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		_, err = netbox.NewDataSource(ctx, "test", &netbox.DataSourceArgs{
    			Name:         pulumi.String("test-data-source"),
    			Type:         pulumi.String("git"),
    			SourceUrl:    pulumi.String("https://example.com/test.git"),
    			Enabled:      pulumi.Bool(true),
    			IgnoreRules:  pulumi.String("*.md"),
    			SyncInterval: pulumi.Float64(1440),
    			Parameters:   pulumi.String(json0),
    			Description:  pulumi.String("test-description"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Netbox = Pulumi.Netbox;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Netbox.DataSource("test", new()
        {
            Name = "test-data-source",
            Type = "git",
            SourceUrl = "https://example.com/test.git",
            Enabled = true,
            IgnoreRules = "*.md",
            SyncInterval = 1440,
            Parameters = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["branch"] = "main",
            }),
            Description = "test-description",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.netbox.DataSource;
    import com.pulumi.netbox.DataSourceArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new DataSource("test", DataSourceArgs.builder()
                .name("test-data-source")
                .type("git")
                .sourceUrl("https://example.com/test.git")
                .enabled(true)
                .ignoreRules("*.md")
                .syncInterval(1440.0)
                .parameters(serializeJson(
                    jsonObject(
                        jsonProperty("branch", "main")
                    )))
                .description("test-description")
                .build());
    
        }
    }
    
    resources:
      test:
        type: netbox:DataSource
        properties:
          name: test-data-source
          type: git
          sourceUrl: https://example.com/test.git
          enabled: true
          ignoreRules: '*.md'
          syncInterval: 1440
          parameters:
            fn::toJSON:
              branch: main
          description: test-description
    
    Example coming soon!
    

    Create DataSource Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataSource(name: string, args: DataSourceArgs, opts?: CustomResourceOptions);
    @overload
    def DataSource(resource_name: str,
                   args: DataSourceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataSource(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   source_url: Optional[str] = None,
                   type: Optional[str] = None,
                   comments: Optional[str] = None,
                   custom_fields: Optional[Mapping[str, str]] = None,
                   description: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   ignore_rules: Optional[str] = None,
                   name: Optional[str] = None,
                   owner_id: Optional[float] = None,
                   parameters: Optional[str] = None,
                   sync_interval: Optional[float] = None)
    func NewDataSource(ctx *Context, name string, args DataSourceArgs, opts ...ResourceOption) (*DataSource, error)
    public DataSource(string name, DataSourceArgs args, CustomResourceOptions? opts = null)
    public DataSource(String name, DataSourceArgs args)
    public DataSource(String name, DataSourceArgs args, CustomResourceOptions options)
    
    type: netbox:DataSource
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "netbox_data_source" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dataSourceResource = new Netbox.DataSource("dataSourceResource", new()
    {
        SourceUrl = "string",
        Type = "string",
        Comments = "string",
        CustomFields = 
        {
            { "string", "string" },
        },
        Description = "string",
        Enabled = false,
        IgnoreRules = "string",
        Name = "string",
        OwnerId = 0.0,
        Parameters = "string",
        SyncInterval = 0.0,
    });
    
    example, err := netbox.NewDataSource(ctx, "dataSourceResource", &netbox.DataSourceArgs{
    	SourceUrl: pulumi.String("string"),
    	Type:      pulumi.String("string"),
    	Comments:  pulumi.String("string"),
    	CustomFields: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Description:  pulumi.String("string"),
    	Enabled:      pulumi.Bool(false),
    	IgnoreRules:  pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	OwnerId:      pulumi.Float64(0),
    	Parameters:   pulumi.String("string"),
    	SyncInterval: pulumi.Float64(0),
    })
    
    resource "netbox_data_source" "dataSourceResource" {
      lifecycle {
        create_before_destroy = true
      }
      source_url = "string"
      type       = "string"
      comments   = "string"
      custom_fields = {
        "string" = "string"
      }
      description   = "string"
      enabled       = false
      ignore_rules  = "string"
      name          = "string"
      owner_id      = 0
      parameters    = "string"
      sync_interval = 0
    }
    
    var dataSourceResource = new DataSource("dataSourceResource", DataSourceArgs.builder()
        .sourceUrl("string")
        .type("string")
        .comments("string")
        .customFields(Map.of("string", "string"))
        .description("string")
        .enabled(false)
        .ignoreRules("string")
        .name("string")
        .ownerId(0.0)
        .parameters("string")
        .syncInterval(0.0)
        .build());
    
    data_source_resource = netbox.DataSource("dataSourceResource",
        source_url="string",
        type="string",
        comments="string",
        custom_fields={
            "string": "string",
        },
        description="string",
        enabled=False,
        ignore_rules="string",
        name="string",
        owner_id=float(0),
        parameters="string",
        sync_interval=float(0))
    
    const dataSourceResource = new netbox.DataSource("dataSourceResource", {
        sourceUrl: "string",
        type: "string",
        comments: "string",
        customFields: {
            string: "string",
        },
        description: "string",
        enabled: false,
        ignoreRules: "string",
        name: "string",
        ownerId: 0,
        parameters: "string",
        syncInterval: 0,
    });
    
    type: netbox:DataSource
    properties:
        comments: string
        customFields:
            string: string
        description: string
        enabled: false
        ignoreRules: string
        name: string
        ownerId: 0
        parameters: string
        sourceUrl: string
        syncInterval: 0
        type: string
    

    DataSource Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DataSource resource accepts the following input properties:

    SourceUrl string
    URL or path of the source.
    Type string
    Kind of backing store. One of: local, git, amazon-s3.
    Comments string
    CustomFields Dictionary<string, string>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    Enabled bool
    Whether NetBox synchronises from this source.
    IgnoreRules string
    Newline-separated glob patterns of files to ignore when synchronising.
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    Parameters string
    Backend-specific parameters as JSON text (use jsonencode()).
    SyncInterval double
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    SourceUrl string
    URL or path of the source.
    Type string
    Kind of backing store. One of: local, git, amazon-s3.
    Comments string
    CustomFields map[string]string
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    Enabled bool
    Whether NetBox synchronises from this source.
    IgnoreRules string
    Newline-separated glob patterns of files to ignore when synchronising.
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    Parameters string
    Backend-specific parameters as JSON text (use jsonencode()).
    SyncInterval float64
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    source_url string
    URL or path of the source.
    type string
    Kind of backing store. One of: local, git, amazon-s3.
    comments string
    custom_fields map(string)
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    enabled bool
    Whether NetBox synchronises from this source.
    ignore_rules string
    Newline-separated glob patterns of files to ignore when synchronising.
    name string
    owner_id number
    Id of the owner the object is assigned to.
    parameters string
    Backend-specific parameters as JSON text (use jsonencode()).
    sync_interval number
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    sourceUrl String
    URL or path of the source.
    type String
    Kind of backing store. One of: local, git, amazon-s3.
    comments String
    customFields Map<String,String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    enabled Boolean
    Whether NetBox synchronises from this source.
    ignoreRules String
    Newline-separated glob patterns of files to ignore when synchronising.
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    parameters String
    Backend-specific parameters as JSON text (use jsonencode()).
    syncInterval Double
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    sourceUrl string
    URL or path of the source.
    type string
    Kind of backing store. One of: local, git, amazon-s3.
    comments string
    customFields {[key: string]: string}
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    enabled boolean
    Whether NetBox synchronises from this source.
    ignoreRules string
    Newline-separated glob patterns of files to ignore when synchronising.
    name string
    ownerId number
    Id of the owner the object is assigned to.
    parameters string
    Backend-specific parameters as JSON text (use jsonencode()).
    syncInterval number
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    source_url str
    URL or path of the source.
    type str
    Kind of backing store. One of: local, git, amazon-s3.
    comments str
    custom_fields Mapping[str, str]
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description str
    enabled bool
    Whether NetBox synchronises from this source.
    ignore_rules str
    Newline-separated glob patterns of files to ignore when synchronising.
    name str
    owner_id float
    Id of the owner the object is assigned to.
    parameters str
    Backend-specific parameters as JSON text (use jsonencode()).
    sync_interval float
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    sourceUrl String
    URL or path of the source.
    type String
    Kind of backing store. One of: local, git, amazon-s3.
    comments String
    customFields Map<String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    enabled Boolean
    Whether NetBox synchronises from this source.
    ignoreRules String
    Newline-separated glob patterns of files to ignore when synchronising.
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    parameters String
    Backend-specific parameters as JSON text (use jsonencode()).
    syncInterval Number
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataSource resource produces the following output properties:

    Created string
    DataSourceId double
    NetBox id.
    FileCount double
    Number of files synced from the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSynced string
    When NetBox last synchronised the source.
    LastUpdated string
    Status string
    Synchronisation status reported by NetBox.
    Url string
    Created string
    DataSourceId float64
    NetBox id.
    FileCount float64
    Number of files synced from the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSynced string
    When NetBox last synchronised the source.
    LastUpdated string
    Status string
    Synchronisation status reported by NetBox.
    Url string
    created string
    data_source_id number
    NetBox id.
    file_count number
    Number of files synced from the data source.
    id string
    The provider-assigned unique ID for this managed resource.
    last_synced string
    When NetBox last synchronised the source.
    last_updated string
    status string
    Synchronisation status reported by NetBox.
    url string
    created String
    dataSourceId Double
    NetBox id.
    fileCount Double
    Number of files synced from the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSynced String
    When NetBox last synchronised the source.
    lastUpdated String
    status String
    Synchronisation status reported by NetBox.
    url String
    created string
    dataSourceId number
    NetBox id.
    fileCount number
    Number of files synced from the data source.
    id string
    The provider-assigned unique ID for this managed resource.
    lastSynced string
    When NetBox last synchronised the source.
    lastUpdated string
    status string
    Synchronisation status reported by NetBox.
    url string
    created str
    data_source_id float
    NetBox id.
    file_count float
    Number of files synced from the data source.
    id str
    The provider-assigned unique ID for this managed resource.
    last_synced str
    When NetBox last synchronised the source.
    last_updated str
    status str
    Synchronisation status reported by NetBox.
    url str
    created String
    dataSourceId Number
    NetBox id.
    fileCount Number
    Number of files synced from the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSynced String
    When NetBox last synchronised the source.
    lastUpdated String
    status String
    Synchronisation status reported by NetBox.
    url String

    Look up Existing DataSource Resource

    Get an existing DataSource resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DataSourceState, opts?: CustomResourceOptions): DataSource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comments: Optional[str] = None,
            created: Optional[str] = None,
            custom_fields: Optional[Mapping[str, str]] = None,
            data_source_id: Optional[float] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            file_count: Optional[float] = None,
            ignore_rules: Optional[str] = None,
            last_synced: Optional[str] = None,
            last_updated: Optional[str] = None,
            name: Optional[str] = None,
            owner_id: Optional[float] = None,
            parameters: Optional[str] = None,
            source_url: Optional[str] = None,
            status: Optional[str] = None,
            sync_interval: Optional[float] = None,
            type: Optional[str] = None,
            url: Optional[str] = None) -> DataSource
    func GetDataSource(ctx *Context, name string, id IDInput, state *DataSourceState, opts ...ResourceOption) (*DataSource, error)
    public static DataSource Get(string name, Input<string> id, DataSourceState? state, CustomResourceOptions? opts = null)
    public static DataSource get(String name, Output<String> id, DataSourceState state, CustomResourceOptions options)
    resources:  _:    type: netbox:DataSource    get:      id: ${id}
    import {
      to = netbox_data_source.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Comments string
    Created string
    CustomFields Dictionary<string, string>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    DataSourceId double
    NetBox id.
    Description string
    Enabled bool
    Whether NetBox synchronises from this source.
    FileCount double
    Number of files synced from the data source.
    IgnoreRules string
    Newline-separated glob patterns of files to ignore when synchronising.
    LastSynced string
    When NetBox last synchronised the source.
    LastUpdated string
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    Parameters string
    Backend-specific parameters as JSON text (use jsonencode()).
    SourceUrl string
    URL or path of the source.
    Status string
    Synchronisation status reported by NetBox.
    SyncInterval double
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    Type string
    Kind of backing store. One of: local, git, amazon-s3.
    Url string
    Comments string
    Created string
    CustomFields map[string]string
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    DataSourceId float64
    NetBox id.
    Description string
    Enabled bool
    Whether NetBox synchronises from this source.
    FileCount float64
    Number of files synced from the data source.
    IgnoreRules string
    Newline-separated glob patterns of files to ignore when synchronising.
    LastSynced string
    When NetBox last synchronised the source.
    LastUpdated string
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    Parameters string
    Backend-specific parameters as JSON text (use jsonencode()).
    SourceUrl string
    URL or path of the source.
    Status string
    Synchronisation status reported by NetBox.
    SyncInterval float64
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    Type string
    Kind of backing store. One of: local, git, amazon-s3.
    Url string
    comments string
    created string
    custom_fields map(string)
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    data_source_id number
    NetBox id.
    description string
    enabled bool
    Whether NetBox synchronises from this source.
    file_count number
    Number of files synced from the data source.
    ignore_rules string
    Newline-separated glob patterns of files to ignore when synchronising.
    last_synced string
    When NetBox last synchronised the source.
    last_updated string
    name string
    owner_id number
    Id of the owner the object is assigned to.
    parameters string
    Backend-specific parameters as JSON text (use jsonencode()).
    source_url string
    URL or path of the source.
    status string
    Synchronisation status reported by NetBox.
    sync_interval number
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    type string
    Kind of backing store. One of: local, git, amazon-s3.
    url string
    comments String
    created String
    customFields Map<String,String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    dataSourceId Double
    NetBox id.
    description String
    enabled Boolean
    Whether NetBox synchronises from this source.
    fileCount Double
    Number of files synced from the data source.
    ignoreRules String
    Newline-separated glob patterns of files to ignore when synchronising.
    lastSynced String
    When NetBox last synchronised the source.
    lastUpdated String
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    parameters String
    Backend-specific parameters as JSON text (use jsonencode()).
    sourceUrl String
    URL or path of the source.
    status String
    Synchronisation status reported by NetBox.
    syncInterval Double
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    type String
    Kind of backing store. One of: local, git, amazon-s3.
    url String
    comments string
    created string
    customFields {[key: string]: string}
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    dataSourceId number
    NetBox id.
    description string
    enabled boolean
    Whether NetBox synchronises from this source.
    fileCount number
    Number of files synced from the data source.
    ignoreRules string
    Newline-separated glob patterns of files to ignore when synchronising.
    lastSynced string
    When NetBox last synchronised the source.
    lastUpdated string
    name string
    ownerId number
    Id of the owner the object is assigned to.
    parameters string
    Backend-specific parameters as JSON text (use jsonencode()).
    sourceUrl string
    URL or path of the source.
    status string
    Synchronisation status reported by NetBox.
    syncInterval number
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    type string
    Kind of backing store. One of: local, git, amazon-s3.
    url string
    comments str
    created str
    custom_fields Mapping[str, str]
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    data_source_id float
    NetBox id.
    description str
    enabled bool
    Whether NetBox synchronises from this source.
    file_count float
    Number of files synced from the data source.
    ignore_rules str
    Newline-separated glob patterns of files to ignore when synchronising.
    last_synced str
    When NetBox last synchronised the source.
    last_updated str
    name str
    owner_id float
    Id of the owner the object is assigned to.
    parameters str
    Backend-specific parameters as JSON text (use jsonencode()).
    source_url str
    URL or path of the source.
    status str
    Synchronisation status reported by NetBox.
    sync_interval float
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    type str
    Kind of backing store. One of: local, git, amazon-s3.
    url str
    comments String
    created String
    customFields Map<String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    dataSourceId Number
    NetBox id.
    description String
    enabled Boolean
    Whether NetBox synchronises from this source.
    fileCount Number
    Number of files synced from the data source.
    ignoreRules String
    Newline-separated glob patterns of files to ignore when synchronising.
    lastSynced String
    When NetBox last synchronised the source.
    lastUpdated String
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    parameters String
    Backend-specific parameters as JSON text (use jsonencode()).
    sourceUrl String
    URL or path of the source.
    status String
    Synchronisation status reported by NetBox.
    syncInterval Number
    Automatic synchronisation interval in minutes. One of: 1, 60, 720, 1440, 10080, 43200.
    type String
    Kind of backing store. One of: local, git, amazon-s3.
    url String

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = netbox_data_source.test

    id = “123”

    }

    The pulumi import command can be used, for example:

    $ pulumi import netbox:index/dataSource:DataSource test 123
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox
    Viewing docs for netbox 6.0.0
    published on Wednesday, Nov 4, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial