Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
88d22f5
docs(endpointprotector): document Show notifications in Hidden Icon m…
claude Apr 21, 2026
2032ba7
Update EPP docs for v5.9.5.3 3rd F&F release
claude Apr 21, 2026
e5dccca
Merge branch 'netwrix:dev' into dev
MRoscaNetwrix Apr 23, 2026
35d521d
consolidated 2509 migration, added mail settings logs and screenshots…
MRoscaNetwrix Apr 23, 2026
ebe51e3
updated NDC bit and screenshot
MRoscaNetwrix Apr 23, 2026
cdcf8f6
updated cap policies with comment related to item 433189 from ADO
MRoscaNetwrix Apr 24, 2026
707e4c2
Merge branch 'netwrix:dev' into dev
MRoscaNetwrix Apr 24, 2026
4ef7759
Merge branch 'dev' into dev
MRoscaNetwrix Apr 27, 2026
c72cfc5
fixed mail settings image reference
MRoscaNetwrix Apr 27, 2026
4caf359
Merge branch 'dev' into dev
MRoscaNetwrix Apr 27, 2026
8667cd8
removed mail settings image reference
MRoscaNetwrix Apr 27, 2026
32533c3
Merge branch 'dev' of https://github.com/MRoscaNetwrix/docs into dev
MRoscaNetwrix Apr 27, 2026
9f7a0e1
feat(changetracker): add interactive API reference for Hub 8.1
jmperez127 Apr 27, 2026
92de5d9
fix(vale): auto-fix substitutions and removals
github-actions[bot] Apr 27, 2026
fa453f8
fix(vale): auto-fix rewrites (AI-assisted)
github-actions[bot] Apr 27, 2026
7f32b5b
fix(dale): auto-fix documentation issues (AI-assisted)
github-actions[bot] Apr 27, 2026
1dba920
fix(changetracker): correct API spec title and version to Hub 8.1
jmperez127 Apr 27, 2026
004409f
fix(vale): auto-fix rewrites (AI-assisted)
github-actions[bot] Apr 27, 2026
809af37
fix(dale): auto-fix documentation issues (AI-assisted)
github-actions[bot] Apr 27, 2026
65142e7
fix(changetracker): revert unintended edits to pre-existing overview …
jmperez127 Apr 27, 2026
ae6a1d4
fix(vale): auto-fix substitutions and removals
github-actions[bot] Apr 27, 2026
55c6c14
fix(vale): auto-fix rewrites (AI-assisted)
github-actions[bot] Apr 27, 2026
a65b37c
fix(dale): auto-fix documentation issues (AI-assisted)
github-actions[bot] Apr 27, 2026
77d1d0a
docs(changetracker): fix API reference link and Hub terminology in ov…
github-actions[bot] Apr 27, 2026
024be9d
fix(vale): auto-fix rewrites (AI-assisted)
github-actions[bot] Apr 27, 2026
fde5121
fix(dale): auto-fix documentation issues (AI-assisted)
github-actions[bot] Apr 27, 2026
05f64ba
Merge branch 'dev' into dev
MRoscaNetwrix Apr 28, 2026
84dbc34
Merge pull request #812 from MRoscaNetwrix/dev
bturlea Apr 28, 2026
4559d8f
Delete docs/endpointprotector/admin/API Logs/installation.md
bturlea Apr 28, 2026
c80b814
Delete docs/endpointprotector/admin/API Logs/logsrestapisetup.md
bturlea Apr 28, 2026
1f905bd
Merge pull request #816 from netwrix/bturlea-ApiLogs-DeleteInstallation
bturlea Apr 28, 2026
2efbd3d
Merge pull request #817 from netwrix/bturlea-apilogs-deleteSetupfile
bturlea Apr 28, 2026
9d3603c
Merge branch 'dev' into jean-perez/changetracker-api-reference
jth-nw Apr 28, 2026
2068c6d
Merge pull request #815 from netwrix/jean-perez/changetracker-api-ref…
jth-nw Apr 28, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/changetracker/8.1/integration/api/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: API Reference
description: Interactive reference for all ChangeTracker Hub API endpoints
sidebar_position: 25
---

import BrowserOnly from '@docusaurus/BrowserOnly';

<BrowserOnly>
{() => {
window.location.replace('/docs/changetracker/8_1/integration/api/reference');
return null;
}}
</BrowserOnly>

Redirecting to the [ChangeTracker Hub API Reference](/docs/changetracker/8_1/integration/api/reference)…
16 changes: 11 additions & 5 deletions docs/changetracker/8.1/integration/api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,21 @@ Netwrix Change Tracker provides a comprehensive REST API that allows customers t

All API endpoints require authentication. See [Authentication](/docs/changetracker/8.1/integration/api/authentication.md) for an example script.

## API Reference

For a complete interactive reference of all Netwrix Change Tracker Hub API endpoints, see the [Netwrix Change Tracker Hub API Reference](/docs/changetracker/8_1/integration/api/reference). The Netwrix Change Tracker Hub (the central management server) generates this reference directly from its OpenAPI 3.0 spec, covering all available endpoints with request/response schemas.

The raw OpenAPI 3.0 spec (YAML) is also [available for download](/openapi/changetracker-hub-8.1.yaml).

## Available Endpoints

The following API endpoints are available in Netwrix Change Tracker:

- [Agents](/docs/changetracker/8.1/integration/api/agents.md) – Pull data on agent statuses, configurations, and group memberships using the agentsRanked endpoint. This API allows you to retrieve detailed information about all agents in your environment, including their group memberships and applied tracking templates.
- [Agents](/docs/changetracker/8.1/integration/api/agents.md) – Pull data on agent statuses, configurations, and group memberships using the agentsRanked endpoint. Use this API to retrieve detailed information about all agents in your environment, including their group memberships and applied tracking templates.

- [Register Agents](/docs/changetracker/8.1/integration/api/register-agents.md) – Normally used by agents to register with the Hub, but this API allows you to register proxied devices to be accessed through a proxy agent.
- [Register Agents](/docs/changetracker/8.1/integration/api/register-agents.md) – Agents normally use this API to register with the Hub, but you can also use it to register proxied devices accessed through a proxy agent.

- [Credentials](/docs/changetracker/8.1/integration/api/credentials.md) – Manage authentication credentials used by ChangeTracker to connect to various systems and services. This API provides endpoints for creating, retrieving, updating, and deleting credentials for different credential types including Shell, Database, FTP, Cloud, ESX, ITSM, and Splunk.
- [Credentials](/docs/changetracker/8.1/integration/api/credentials.md) – Manage authentication credentials that ChangeTracker uses to connect to various systems and services. This API provides endpoints for creating, retrieving, updating, and deleting credentials for different credential types including Shell, Database, FTP, Cloud, ESX, ITSM, and Splunk.

## API Usage Best Practices

Expand All @@ -38,7 +44,7 @@ When working with the ChangeTracker API, consider the following best practices:

## Example Usage

Below is a simple example of how to use the API with PowerShell:
The following example shows how to use the API with PowerShell:

```powershell
# Set up a session variable for the Admin user
Expand All @@ -64,4 +70,4 @@ $requestBody = @{
$result = Invoke-RestMethod -Method Post -ContentType application/json -Uri $uri -WebSession $myWebSession -Body $requestBody
```

For more detailed information about each API endpoint, please refer to the specific API documentation pages linked above.
See the [Available Endpoints](#available-endpoints) section for documentation pages covering each API endpoint.
Loading
Loading