Document method for rendering configurations as raw text #9020

Closed
opened 2025-12-29 20:44:17 +01:00 by adam · 1 comment
Owner

Originally created by @jeremystretch on GitHub (Jan 2, 2024).

Originally assigned to: @bluikko on GitHub.

Change Type

Addition

Area

Features

Proposed Changes

The current documentation for configuration rendering explains how a REST API request can be made to render a configuration template, which will return a JSON response. This are should be extended to also note how the rendered configuration can be returned in plaintext (by setting the Accept: text/plain HTTP header).

Originally created by @jeremystretch on GitHub (Jan 2, 2024). Originally assigned to: @bluikko on GitHub. ### Change Type Addition ### Area Features ### Proposed Changes The current documentation for [configuration rendering](https://docs.netbox.dev/en/stable/features/configuration-rendering/) explains how a REST API request can be made to render a configuration template, which will return a JSON response. This are should be extended to also note how the rendered configuration can be returned in plaintext (by setting the `Accept: text/plain` HTTP header).
adam added the status: acceptedtype: documentation labels 2025-12-29 20:44:17 +01:00
adam closed this issue 2025-12-29 20:44:18 +01:00
Author
Owner

@bluikko commented on GitHub (Jan 17, 2024):

Took a stab at this since it's been weeks & seemed like quite a simple thing to do. Not sure what is the preferred verbosity level of the text so kept it very simple, hope the style is acceptable for the project.

@bluikko commented on GitHub (Jan 17, 2024): Took a stab at this since it's been weeks & seemed like quite a simple thing to do. Not sure what is the preferred verbosity level of the text so kept it very simple, hope the style is acceptable for the project.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9020