Check publication status

After you publish security updates, you can check their deployment status using the NGINX Instance Manager REST API.

These endpoints help you verify whether security policies, log profiles, and other configurations were successfully deployed to instances or instance groups.

Use tools such as curl or Postman to send requests to the NGINX Instance Manager REST API. The API base URL is https://<NIM-FQDN>/api/[nim|platform]/<API_VERSION>.
All requests require authentication. For details on authentication methods, see the API overview.

Check publication status for a security policy

To view deployment status for a specific policy, send a GET request to the Security Deployments Associations API using the policy name.

Example:

curl -X GET "https://{{NIM_FQDN}}/api/platform/v1/security/deployments/associations/ignore-xss" \
  -H "Authorization: Bearer <access token>"

In the response, check the lastDeploymentDetails field under instance or instanceGroup.instances for deployment results.

Check publication status for a security log profile

Example:

curl -X GET "https://{{NIM_FQDN}}/api/platform/v1/security/deployments/logprofiles/associations/default-log" \
  -H "Authorization: Bearer <access token>"

The response includes a lastDeploymentDetails field for each instance or instance group.

Check status for a specific instance

To view deployment status for a specific instance, provide the system UID and instance UID.

Example:

curl -X GET "https://{{NIM_FQDN}}/api/platform/v1/systems/<system-uid>/instances/<instance-uid>" \
  -H "Authorization: Bearer <access token>"

In the response, the lastDeploymentDetails field shows deployment status, timestamps, and any related error messages.

Check deployment result by deployment ID

When you use the Publish API to publish security content, NGINX Instance Manager assigns a deployment ID to the request.
You can use this ID to check the final result of the publication.

Example:

curl -X GET "https://{{NIM_FQDN}}/api/platform/v1/systems/instances/deployments/<deployment-id>" \
  -H "Authorization: Bearer <access token>"

The response includes detailed deployment information, including success or failure status and any compiler error messages.