API Overview

This topic gives an overview of the Instance Manager API.

Introduction

NGINX Management Suite Instance Manager provides a REST API that uses standard authentication methods, HTTP response codes, and verbs.

Object Model

The Instance Manager REST API allows you to manage Instance Manager objects and the NGINX Management Suite platform programmatically. The Instance Manager API provides the following features:

• View metrics and information about data plane host systems and NGINX instances.
• View and edit NGINX configurations.
• Save NGINX configurations for future deployment.
• Analyze saved and current configurations for syntactic errors.
• Publish configurations to NGINX instances.
• Scan the network to find unmanaged NGINX instances.
• Manage certificates.
• Create users, roles, and role permissions to manage RBAC.

API Reference Documentation

You can access the Instance Manager and Platform API Reference documentation through the NGINX Management Suite web interface.

To access the API Docs, take the steps below:

1. In a web browser, go to the FQDN for your NGINX Management Suite host and log in. Then, select API Documentation from the Launchpad menu.
2. In the left-menu, select NIM and Platform API.

Authentication

Instance Manager supports authentication by using basic authentication or a JSON Web Token (JWT). You can get a JWT by logging in with an OpenID Connect (OIDC) Identity Provider.

For more information about the available authentication options for NGINX Management Suite, refer to Set Up Authentication.

Basic Authentication

To use basic authentication for API requests, include your base64-encoded credentials as a “Basic” token in the “Authorization” header. Here’s how you can do it with cURL:

curl -X GET "https://<NMS_FQDN>/api/platform/<API_VERSION>/systems" -H "Authorization: Basic YWRtaW..."

In this example, replace <NMS_FQDN> with your NGINX Management Suite’s fully qualified domain name and <API_VERSION> with the API version you want to use.

The flag -H "Authorization: Basic YWRtaW..." sets the “Authorization” header with your base64-encoded username and password. Replace YWRtaW... with your actual encoded credentials.

Security Consideration
You can use basic authentication for API requests, but you should be cautious: credentials are sent as base64-encoded text, which is not secure encryption. If your data gets intercepted, the encoding is easily reversible. In production environments where security is critical, we recommend switching to OpenID Connect (OIDC).

JSON Web Token

If your organization is using OIDC, you will be prompted to log in with your Identity Provider the first time you attempt to reach an API. After authenticating, you can request a JWT to use in subsequent API calls.

Note:
The means of requesting a token varies according to the Identity Provider; if you’re not sure which provider your organization uses, check with your system administrator or technical support team.

The JWT should be sent as a “bearer” token using the “Authorization” request header field with the “Bearer” authentication scheme, as shown in the example below.

curl -X GET "https://<NMS_FQDN>/api/platform/<API_VERSION>/systems" -H "Authorization: Bearer xxxxx.yyyyy.zzzzz"

Usage

You can use tools such as curl or Postman to interact with the Instance Manager REST API. The API URL follows the format https://<NMS_FQDN>/api/platform/<API_VERSION>.

Note:
When making API calls by using curl, Postman, or any other tool, you will need to provide your authentication information with each call.

You can also use the “Try it Out” function in the API Reference docs to send a call to the Instance Manager API. You do not have to provide a means of authentication when sending API calls via the API Documentation UI because you are already logged in to the NGINX Management Suite platform.

To do so, take the steps below:

1. Select the endpoint and action that you want to send. For example: POST /infrastructure/workspaces.
2. Select the Try it Out button.
3. If the endpoint accepts parameters, replace the placeholder examples in the request body with your desired values.
4. Select the Execute button to send the request.
5. When the request completes, the response appears in the UI.

Errors and Response Codes

Instance Manager uses standard HTTP response codes to indicate whether an API request succeeds or fails. Codes in the 2xx range mean the request succeeded. Codes in the 400 range mean the request failed due to the reason(s) indicated in the response message. Common reasons for 4xx responses are:

• requests where required information is missing;
• lack of or incorrect authentication credentials; and
• requests that refer to resources that do not exist or are in use by other resources.

HTTP Status Codes

Encoding

All Instance Manager API endpoints expect and return JSON-formatted data by default.

All JSON-formatted data is expected to be encoded using UTF-8. If you do not specify a specific media type in an API call, then the API defaults to application/json.

Pagination

Top-level Instance Manager API endpoints support fetching information about multiple resources (“lists”). Such requests may return large data sets (for example, GET /events and GET /instances). In these cases, you can define the size of the data set returned for each call and navigate amongst the pages of data by sending subsequent calls.

Parameters

Versioning

Each major version of the Instance Manager API is backward-compatible with the previous releases in that version. The introduction of backward-incompatible changes to the Instance Manager API constitutes a major version change. This will be represented in the <version> section of the API URI.

For example, to use a v2 API, you would send requests to https://<NMS_FQDN>/api/platform/v2.

When any Instance Manager component requires a version change, we will release a new version of the entire API. You will not see a mix of v1 and v2 objects in the same API.