Cohesity

Cohesity Active Directory API

The Active Directory API from Cohesity — 13 operation(s) for active directory.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /public/activeDirectory List AD domains the cluster has joined (legacy) · Lists the Active Directories that the Cohesity Cluster has joined #
Ask an LLM
“Which Active Directory domains is my Cohesity cluster joined to, using the older public endpoint?”
“Can I see the joined AD domains for a particular tenant?”
Tell an agent
List the joined Active Directory entries for domains {domains} via the public API.
Show the legacy AD join entries for tenants {tenantIds}.
POST /public/activeDirectory Join the cluster to an AD domain (legacy) · Join the Cohesity Cluster to the specified Active Directory #
Ask an LLM
“Can I join the cluster to an Active Directory domain through the older public API so domain users can log in?”
“Which OU and machine accounts are used when joining the cluster to a domain the legacy way?”
Tell an agent
Join the cluster to domain {domainName} as {userName} using the public activeDirectory endpoint.
Join {domainName} with machine accounts {machineAccounts} in OU {ouName} via the legacy join.
DELETE /public/activeDirectory Leave an AD domain (legacy) · Deletes the join with the Active Directory #
Ask an LLM
“What happens to domain users' access if the cluster leaves an Active Directory domain?”
“Can I remove the cluster's join to a domain with the older public endpoint?”
Tell an agent destructive · confirm first
Remove the cluster's legacy join to domain {domainName}.
Unjoin {domainName} using admin {userName} through the public activeDirectory API.
GET /public/activeDirectory/centrifyZones List Centrify zones of an AD domain · Fetches the list centrify zones of an active directory domain #
Ask an LLM
“Which Centrify zones exist in my Active Directory domain?”
“Can I see Centrify zone options before configuring UNIX identity mapping?”
Tell an agent
List Centrify zones in domain {domainName}.
Show the Centrify zones available for {domainName}.
GET /public/activeDirectory/domainControllers List a joined domain's controllers (legacy) · List the domain controllers for a domain #
Ask an LLM
“Which domain controllers does the cluster see for a joined domain via the public endpoint?”
“Can I check which DCs are reachable for a domain using the legacy activeDirectory path?”
Tell an agent
List the domain controllers for joined domain {domainName} via the public API.
Show the DCs the legacy activeDirectory endpoint finds for {domainName}.
GET /public/activeDirectory/principals Search AD users and groups · List the user and group principals in the Active Directory that match the… #
Ask an LLM
“Can I search Active Directory for a user or group by part of their name?”
“Which AD principals match a list of SIDs, and can computer accounts be included?”
Tell an agent
Search domain {domain} for principals matching {search}.
Look up the AD principals with SIDs {sids}.
POST /public/activeDirectory/principals Add AD users or groups with Cohesity roles · Add multiple groups or users on the Cohesity Cluster for the specified Active… #
Ask an LLM
“How do I give an Active Directory group access to the cluster with a specific Cohesity role?”
“Can I add several AD users at once and map them to roles?”
Tell an agent
Add these Active Directory groups to the cluster and assign them Cohesity roles.
Grant AD users access to the cluster with the Viewer role.
POST /public/activeDirectory/{name}/enableTrustedDomainState Turn trusted domain discovery on or off · Updates the states of trusted domains discovery #
Ask an LLM
“Can I stop the cluster from discovering trusted domains of a joined AD domain?”
“Is trusted domain discovery something I can toggle per Active Directory?”
Tell an agent
Enable trusted domain discovery for {name}.
Set trusted domain discovery on {name} to {trustedDomainsEnabled}.
PUT /public/activeDirectory/{name}/idMappingInfo Update an AD domain's user ID mapping · Updates the user id mapping info of an Active Directory #
Ask an LLM
“How are AD users mapped to UNIX user IDs, and can I change that mapping for a domain?”
“Can I set a fallback ID mapping or UNIX root SID for an Active Directory?”
Tell an agent
Update user ID mapping for {name} to {userIdMappingInfo}.
Set the UNIX root SID of {name} to {unixRootSid}.
PUT /public/activeDirectory/{name}/ignoredTrustedDomains Set trusted domains to ignore · Updates the list of trusted domains to be ignored during trusted domain… #
Ask an LLM
“Can I exclude certain trusted domains from discovery on a joined AD domain?”
“Which trusted domains are skipped during discovery, and can I change the list?”
Tell an agent
Ignore trusted domains {ignoredTrustedDomains} for {name}.
Update the ignored trusted domain list of {name}.
PUT /public/activeDirectory/{name}/ldapProvider Set the LDAP provider for an AD domain · Updates the LDAP provide Id for an Active Directory domain #
Ask an LLM
“Can I associate an LDAP provider with a joined Active Directory domain?”
“What changes if I swap the LDAP provider used by an AD domain?”
Tell an agent
Set the LDAP provider of {name} to {ldapProviderId}.
Link LDAP provider {ldapProviderId} to Active Directory {name}.
POST /public/activeDirectory/{name}/machineAccounts Update a domain's machine accounts (legacy) · Updates the machine accounts of an Active Directory #
Ask an LLM
“Can I add machine accounts to an Active Directory the cluster already joined, via the older endpoint?”
“Will existing machine accounts be overwritten when I update them for a domain?”
Tell an agent
Set machine accounts {machineAccounts} on joined domain {name} using admin {userName}.
Update the machine accounts of {name}, overwriting existing ones.
PUT /public/activeDirectory/{name}/preferredDomainControllers Set preferred domain controllers for AD · Update preferred domain controllers #
Ask an LLM
“Can I tell the cluster which domain controllers to prefer for a joined domain?”
“Which DCs does the cluster talk to first, and can I pin that list?”
Tell an agent
Update the preferred domain controllers of {name}.
Make the cluster prefer specific domain controllers for {name}.
GET /active-directories List Active Directories (v2) · Get the list of Active Directories #
Ask an LLM
“Which Active Directories are configured on the cluster under the newer active-directories API?”
“Can I filter configured Active Directories by domain name or tenant?”
Tell an agent
List configured Active Directories for domains {domainNames}.
Show Active Directories with ids {ids}.
POST /active-directories Add an Active Directory (v2) · Create an Active Directory #
Ask an LLM
“What do I need to provide to configure a new Active Directory with the active-directories API?”
“Can I join a domain in a specific organizational unit with overwrite of machine accounts?”
Tell an agent
Create an Active Directory for {domainName} with machine accounts {machineAccounts} and admin credentials {activeDirectoryAdminParams}.
Add domain {domainName} in OU {organizationalUnitName} with machine accounts {machineAccounts} and admin {activeDirectoryAdminParams}.
GET /active-directories/{id} Get one Active Directory's details · Get an Active Directory by id #
Ask an LLM
“Can I see a configured Active Directory's domain controllers and Centrify zones in one call?”
“What security principals with a given prefix exist in one configured Active Directory?”
Tell an agent
Get Active Directory {id}.
Show Active Directory {id} with principals starting {prefix}.
PUT /active-directories/{id} Update an Active Directory (v2) · Update an Active Directory #
Ask an LLM
“Can I change the preferred domain controllers or trust settings of a configured Active Directory?”
“How deep can transitive AD trusts go, and can I change that limit?”
Tell an agent
Update Active Directory {id} with machine accounts {machineAccounts}.
Set the transitive trust level limit of Active Directory {id} to {transitiveAdTrustLevelLimit}, keeping machine accounts {machineAccounts}.
DELETE /active-directories/{id} Delete an Active Directory (v2) · Delete an Active Directory #
Ask an LLM
“What credentials are needed to remove a configured Active Directory from the cluster?”
“Can I delete an Active Directory configuration by its id?”
Tell an agent destructive · confirm first
Delete Active Directory {id} using admin {activeDirectoryAdminUsername} and password {activeDirectoryAdminPassword}.
Remove the Active Directory configuration {id}.
GET /domain-controllers Get domain controllers for domains · Get Domain Controllers of specified domains #
Ask an LLM
“Which domain controllers serve the domains I list, even before the cluster joins them?”
“Can I discover DCs for several domains through a specific connection?”
Tell an agent
Get domain controllers for domains {domainNames}.
Find the DCs for {domainNames} through connection {connectionId}.

Documentation

📖
Documentation
https://developer.cohesity.com/helios-api.html
📖
GettingStarted
https://developer.cohesity.com/docs/helios-getting-started
📖
APIReference
https://developer.cohesity.com/apidocs/versions/
📖
Documentation
https://developer.cohesity.com/apidocs/versions/
📖
APIReference
https://developers.cohesity.com/page/api-reference
📖
GettingStarted
https://developers.cohesity.com/docs/getting-started
📖
Documentation
https://developer.cohesity.com/apidocs/helios-reporting
📖
Documentation
https://developer.cohesity.com/apidocs/site-continuity

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-active-directory-api-openapi.yml

Other Resources

🔗
Postman
https://api.cohesity.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cohesity:cohesity-active-directory-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cohesity-active-directory-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cohesity Active Directory API
  version: '1.0'
  description: 'Operations tagged ActiveDirectory across 2 of this provider''s published API definitions: cohesity-cluster-v1-openapi-original.yml, cohesity-cluster-v2-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://<CLUSTER_VIP>/irisservices/api/v1
- url: /v2
tags:


# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-active-directory-api-openapi.yml