Skip to content

ContactRole

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

ContactRole

A functional role for contacts (e.g. NOC, billing, emergency).

API Endpoint

/api/tenancy/contact-roles/

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').
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 emergencyRole 'ContactRole' = {
  name: 'Emergency Contact'
  description: 'Emergency contact for critical incidents'
}

Clone this wiki locally