---
title: "Appendix: API Reference & Specifications"
slug: "appendix-api-reference-specifications"
updated: 2025-12-19T16:29:08Z
published: 2025-12-19T16:29:08Z
canonical: "docs.ssw.splashtop.com/appendix-api-reference-specifications"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ssw.splashtop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Appendix: API Reference & Specifications

This section provides links to the **official API specifications and detailed endpoint references** used in this guide.

The end-to-end examples above focus on **real-world workflows**. For complete request/response schemas, parameters, and error definitions, refer to the API specifications below.

---

## 1) Authentication & IAM APIs

These APIs are used for:

- API key authentication
- User (organization member) management
- Group and group membership management
- Application enablement at the organization level

### IAM API Specification (OpenAPI)

- **IAM API OpenAPI spec**

[iam-API-0.1.yaml](https://download.ssw.splashtop.com/api-doc/iam-API-0.1.go)

*(Includes authentication, users, groups, and membership endpoints)*

### Key Endpoints Referenced in This Guide

| Capability | Endpoint |
| --- | --- |
| Authenticate API key | `POST /iam/v1/apikey/authenticate` |
| List organization members | `GET /iam/v1/organization/members` |
| List groups | `GET /iam/v1/organization/{organization_id}/groups` |
| List group members | `GET /iam/v1/group/members` |
| Add user to group | `POST /iam/v1/group/{group_id}/members/{user_id}` |
| Remove user from group | `DELETE /iam/v1/group/{group_id}/members/{user_id}` |
| Approve group join | `POST /iam/v1/group/{group_id}/members/{user_id}/approval` |
| Reject group join | `POST /iam/v1/group/{group_id}/members/{user_id}/reject` |
| Update group | `PUT /iam/v1/group` |
| Delete group | `DELETE /iam/v1/group/{group_id}` |

---

## 2) Application & ZTNA APIs

These APIs are used for:

- Importing application configurations
- Enabling/disabling applications
- Exporting application configurations
- Deleting applications

### Controller / ZTNA API Specification (OpenAPI)

- **Controller API OpenAPI spec**  

[controller-API-0.1.yaml](https://download.ssw.splashtop.com/api-doc/controller-API-0.1.yaml)

### Key Endpoints Referenced in This Guide

| Capability | Endpoint |
| --- | --- |
| Import application (JSON) | `POST /ztna/v1/application/import_json` |
| Enable application | `PUT /ztna/v1/application/{app_id}/enabled` |
| Export application | `POST /ztna/v1/application/export_json` |
| Delete application | `DELETE /ztna/v1/application/{app_id}` |

---

## 3) Secrets APIs (If Applicable)

If your automation includes secrets management, refer to:

- **Secrets API OpenAPI spec**

[secret-API-0.1.yaml](https://download.ssw.splashtop.com/api-doc/secert-API-0.1.yml)

> Note: Secrets APIs use a **Secrets Key** and are scoped separately from IAM and Controller APIs.

---