# Kiteworks API Playground

> Kiteworks API Playground: run live API calls directly in your browser wihtout running any boilerplate. The fastest way to explore what the API can do.

API Fundamentals

# Kiteworks API Playground

The Kiteworks API Playground lets you run real API calls directly in the browser, without writing any boilerplate. It's the fastest way to explore what the API can do before integrating it into your own application.

## Overview

The Playground provides Python code samples and step-by-step instructions for the most common Kiteworks workflows. Most samples can be executed directly in the interface — the response is displayed alongside the code, giving you an immediate, real result from your own instance. You can copy any sample directly into your IDE as a starting point.

> **The Playground is not a sandbox.** Every request you run executes against your live Kiteworks instance. Actions such as creating folders, uploading files, or provisioning users will take effect immediately.

## Access Requirements

### License

The API Playground is included with any active API license. It is also available during the **Kiteworks Secure API free 60-day trial** — no paid subscription is required to evaluate the Playground.

### User role

Only users with the **Developer** role, or a custom role with developer permissions, can access the Playground and the API Documentation app. If you don't see the Playground in your App Switcher, ask your Kiteworks administrator to assign you the correct role.

### Enable API Documentation (administrators)

1. **Open the API settings.** In the Kiteworks Admin console, go to **Application Setup → Apps and Plugins → API**.
2. **Enable the toggle.** Turn on the **Enable API Documentation** toggle. This makes both the API Documentation and the Playground visible to eligible users.
3. **Assign the Developer role.** Go to **Users → User Management**, select the relevant users, then click **More → Change User Role** and select **Developer**.

### Open the Playground

Once access is configured, users can reach the Playground and API Documentation apps via the **App Switcher** in the upper-right corner of the Kiteworks interface.

## Network Requirements

The Playground communicates with an AWS-hosted backend to execute requests. This means it **cannot be used in air-gapped environments**. If your Kiteworks appliance is behind a firewall, you must open the traffic described below.

### Inbound connections (to Kiteworks)

The Playground backend initiates connections to your Kiteworks appliance on port 443. Allow inbound HTTPS traffic from the following source IPs:

| Source IP | Protocol | Port |
|---|---|---|
| `44.240.1.181` | TCP | 443 |
| `34.216.185.66` | TCP | 443 |

> Unsure which IP applies to your deployment? Check your firewall logs — the correct IP will appear as a blocked inbound connection attempt on port 443.

### Outbound connections (from Kiteworks)

Your Kiteworks appliance must be able to reach the AWS API Gateway backend in **us-west-2**. Allow outbound TCP 443 traffic to the AWS API Gateway CIDR ranges for that region:

| Destination | Protocol | Port |
|---|---|---|
| AWS API Gateway — `us-west-2` CIDR ranges | TCP | 443 |

For the full list of AWS IP ranges, refer to the [AWS IP Address Ranges documentation ↗](https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html).

> **Air-gapped environments.** The Playground cannot be used when outbound internet access from the Kiteworks appliance is blocked. In these environments, use the [API Reference](api-reference.html) and your own local tooling (e.g. cURL or Postman) to test calls instead.

## Next Steps

Ready to explore? Once access and firewall rules are configured:

- Open the App Switcher in Kiteworks and launch **Secure API Playground**
- [Authentication →](authentication.html) Learn how to obtain the OAuth tokens the Playground uses on your behalf
- [API Reference →](api-reference.html) Browse all available endpoints