# Fortanix Groups API

**Canonical:** https://apis.io/apis/fortanix/fortanix-groups-api/  
**Provider:** Fortanix — https://apis.io/providers/fortanix/  
**Base URL:** https://amer.smartkey.io  
**Documentation:** https://support.fortanix.com/apidocs/dsm-introduction

Fortanix Groups API is one of 51 APIs that [Fortanix](https://apis.io/providers/fortanix/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Groups API from Fortanix — 10 operation(s) for groups.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| POST | `/sys/v1/groups/{group_id}/hmg/scans` | Scan external objects asynchronously. |
| GET | `/sys/v1/groups/{group_id}/hmg/scans` | Retrieve the scan status of an external group. |
| POST | `/sys/v1/groups/{group_id}/hmg/check` | Check that the HMG configuration for a particular group is valid and reachable. |
| POST | `/sys/v1/groups/hmg/check` | Check that the HMG configuration provided is valid and reachable. |
| POST | `/sys/v1/groups` | Create a new group with the specified properties. |
| GET | `/sys/v1/groups` | Get all groups accessible to the requester. |
| DELETE | `/sys/v1/groups/{group_id}` | Delete the group. |
| GET | `/sys/v1/groups/{group_id}` | Lookup a specific group. |
| PATCH | `/sys/v1/groups/{group_id}` | Change a group's properties. |
| POST | `/sys/v1/groups/hmg/gcp_key_rings` | Given an GCP configuration, fetch a list of available GCP key rings which can be used to back a group. |
| GET | `/sys/v1/groups/{group_id}/hmg/scans/{scan_id}` | Query the status of a particular scan. Only the last five completed scans,as well as any in-progress scan, is queryable. |
| POST | `/sys/v1/groups/hmg/azure_vaults` | Given an Azure configuration, fetch a list of available Azure key vaults which can be used to back a group. |
| POST | `/sys/v1/groups/hmg/scan_collections` | Using the chosen credential, list the key collections available. |
| POST | `/sys/v1/groups/{group_id}/hmg/scan` | Scan external objects. |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/fortanix/refs/heads/main/openapi/fortanix-groups-api-openapi.yml
- **Documentation** — https://support.fortanix.com/docs/dsm-rest-apis
- **APIReference** — https://support.fortanix.com/apidocs/dsm-introduction
- **APIReference** — https://support.fortanix.com/apidocs/armor-ki-introduction
- **Documentation** — https://support.fortanix.com/docs/fortanix-armor-rest-apis

## Other Fortanix APIs (12)

- [Fortanix Confidential Computing Manager REST API](https://apis.io/apis/fortanix/ccm/)
- [Fortanix Account Extensions API](https://apis.io/apis/fortanix/fortanix-account-extensions-api/)
- [Fortanix Accounts API](https://apis.io/apis/fortanix/fortanix-accounts-api/)
- [Fortanix Admin API](https://apis.io/apis/fortanix/fortanix-admin-api/)
- [Fortanix App API](https://apis.io/apis/fortanix/fortanix-app-api/)
- [Fortanix Application Config API](https://apis.io/apis/fortanix/fortanix-applicationconfig-api/)
- [Fortanix Approval Requests API](https://apis.io/apis/fortanix/fortanix-approval-requests-api/)
- [Fortanix Approval Requests API](https://apis.io/apis/fortanix/fortanix-approvalrequests-api/)
- [Fortanix Apps API](https://apis.io/apis/fortanix/fortanix-apps-api/)
- [Fortanix Auth API](https://apis.io/apis/fortanix/fortanix-auth-api/)
- [Fortanix Authentication API](https://apis.io/apis/fortanix/fortanix-authentication-api/)
- [Fortanix Batch API](https://apis.io/apis/fortanix/fortanix-batch-api/)

## Tags

Group

---

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