Skip to content

N1 Console. Set up a "runbook"-style how-to for managing CSGs #1063

@mjang

Description

@mjang

Overview

As someone whose setting up Config Sync Groups (CSGs), I need to see example REST calls that allow users to manage CSGs with the API. While some users may set up CSGs with the UI, others may prefer the API, to automate the process.

Description

I'm visualizing a sequential procedure. I'd include it as a separate page in https://docs.nginx.com/nginx-one/api.

On that page, i'd specify:

<section> Manage your CSGs

"In the following sections, you can use our API to:

  • Create a CSG
  • Add a new instance to a CSG
  • Modify the CSG

To run these commands, you need (prerequisites)

<section> Create a new Config Sync Group with POST

Link to API endpoint

curl -X POST something

Explain how this creates the CSG

<section> Add a new instance to a Config Sync Group

etc.

Acceptance criteria

Reviewers who successfully test the procedure

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationproduct/nginx-oneIssues related to NGINX One Console

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions