---
title: Swagger REST API Setup
slug: swagger-rest-api-setup
createdAt: 2025-06-11T20:26:17.823Z
---

## Activate REST API Overview

Activate includes a REST API with a Swagger UI interface that allows customers and integrated systems to pass data to Activate for processing. This document describes the basic setup of the Activate REST API.

## IIS Configuration

1. Open **IIS Manager** and navigate to **Sites > Default Web Site > Activate**. 
2. Ensure that the **Activate Website** is configured for **Anonymous Authentication**. 

## Activate Studio Configuration

By default, members of the built-in **Activate Developer** role have access to use the REST API.

1. For service accounts and other API users, create a new role called **Activate API User** and add a **Members** parameter (typically referencing an AD group). 
2. Navigate to //Resources/API and confirm that **Windows Authentication** is enabled in the **Authentication** parameter. 
3. Add the **Activate API User** role to the **Security** settings for the //Resources/API object. 
4. Navigate to the Swagger URL for your instance. 
   - Default URL: http(s)://\<serverFQDN>/swagger&#x20;
   - Example: http\://myact02/swagger&#x20;

You can now test or execute API queries and functions through the Swagger interface.

Swagger runs under the context of the authenticated user. The user must have appropriate access within Activate to run or submit actions.

1. Test an API call — for example, using the job/&#x7B;id} method to retrieve job information.&#x20;

For additional guidance or support, contact your **Activate representative**.