# VAST Data Active Directory API

**Canonical:** https://apis.io/apis/vastdata/vastdata-active-directory-api/  
**Provider:** VAST Data — https://apis.io/providers/vastdata/  
**Base URL:** https://{vms-host}/api  
**Documentation:** https://www.vastdata.com/platform/developers

VAST Data Active Directory API is one of 123 APIs that [VAST Data](https://apis.io/providers/vastdata/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Active Directory. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and SDKs.

Active Directory is supported as an external authorization and authentication provider.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| GET | `/activedirectory/` | List Active Directory Configurations |
| POST | `/activedirectory/` | Create Active Directory Configuration |
| DELETE | `/activedirectory/{id}/` | Delete Active Directory configuration |
| GET | `/activedirectory/{id}/` | Return Active Directory Configuration Details |
| PATCH | `/activedirectory/{id}/` | Join or Leave Active Directory |
| POST | `/activedirectory/{id}/change_machine_account_password/` | Change machine account password |
| GET | `/activedirectory/{id}/current_gc/` | Get current Active Directory GC |
| GET | `/activedirectory/{id}/dcs/` | Get Active Directory DCs |
| GET | `/activedirectory/{id}/domains/` | Get Active Directory domains |
| GET | `/activedirectory/{id}/gcs/` | Get Active Directory GCs |
| POST | `/activedirectory/{id}/is_operation_healthy` | Check whether an operation may be successfully performed |
| PATCH | `/activedirectory/{id}/refresh/` | Refresh AD |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/vastdata/refs/heads/main/openapi/vastdata-active-directory-api-openapi.yml
- **Documentation** — https://support.vastdata.com/s/
- **SDK** — https://github.com/vast-data/vastpy

## Other VAST Data APIs (12)

- [VAST Data Alarms API](https://apis.io/apis/vastdata/vastdata-alarms-api/)
- [VAST Data Basicsettings API](https://apis.io/apis/vastdata/vastdata-basicsettings-api/)
- [VAST Data Bgpconfigs API](https://apis.io/apis/vastdata/vastdata-bgpconfigs-api/)
- [VAST Data Blob Expansions API](https://apis.io/apis/vastdata/vastdata-blob-expansions-api/)
- [VAST Data Block Hosts API](https://apis.io/apis/vastdata/vastdata-block-hosts-api/)
- [VAST Data Blockmappings API](https://apis.io/apis/vastdata/vastdata-blockmappings-api/)
- [VAST Data Callhomeconfigs API](https://apis.io/apis/vastdata/vastdata-callhomeconfigs-api/)
- [VAST Data Capacity API](https://apis.io/apis/vastdata/vastdata-capacity-api/)
- [VAST Data Carriers API](https://apis.io/apis/vastdata/vastdata-carriers-api/)
- [VAST Data Cboxes API](https://apis.io/apis/vastdata/vastdata-cboxes-api/)
- [VAST Data Certificates API](https://apis.io/apis/vastdata/vastdata-certificates-api/)
- [VAST Data Challengetokens API](https://apis.io/apis/vastdata/vastdata-challengetokens-api/)

## Tags

Active Directory

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/vastdata/vastdata-active-directory-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/vastdata/.