Skip to content
Sebastian Claesson edited this page Mar 29, 2026 · 1 revision

Region

A geographic region (e.g. continent, country, state).

API Endpoint

/api/dcim/regions/

Identifier

name - Unique name.

Properties

Property Type Required Description
name string Yes Unique name.
slug string No URL-friendly identifier (auto-generated from name if omitted, e.g. 'my-datacenter').
parent string No The parent region ID (for nesting).
description string No A brief description.
comments string No Free-text comments (markdown supported).

Output Properties

Property Type Description
id string NetBox internal ID (read-only, returned after create/update).
url string API URL for this resource.
display string Display name.

Bicep Example

resource europe 'Region' = {
  name: 'Europe'
  description: 'European operations'
}

resource sweden 'Region' = {
  name: 'Sweden'
  parent: europe.id
  description: 'Sweden region'
}

Clone this wiki locally