---
title: Accessing the interactive administrative API documentation
description: View interactive documentation for the administrative API endpoints.
component: pingaccess
version: 9.0
page_id: pingaccess:installing_and_uninstalling_pingaccess:pa_accessing_the_api_docs
canonical_url: https://docs.pingidentity.com/pingaccess/9.1/installing_and_uninstalling_pingaccess/pa_accessing_the_api_docs.html
revdate: February 6, 2023
superseded_by: https://docs.pingidentity.com/pingaccess/9.1/installing_and_uninstalling_pingaccess/pa_accessing_the_api_docs.html
section_ids:
  steps: Steps
  example: Example:
  example-2: Example:
  result: Result:
---

# Accessing the interactive administrative API documentation

View interactive documentation for the administrative API endpoints.

## Steps

1. Launch your browser and go to `https://<host>:<admin-port>/pa-admin-api/v3/api-docs/`.

   ### Example:

   `https://localhost:9000/pa-admin-api/v3/api-docs/`

   |   |                                                         |
   | - | ------------------------------------------------------- |
   |   | The browser might prompt you to enter your credentials. |

2. Enter the administrator username and password.

3. Use the administrative API to perform a variety of administrative tasks, such as gathering information.

   ### Example:

   To use the interactive administrative API documentation to see all defined applications:

   1. Click to expand the `/applications` endpoint.

   2. Click to expand the `GET` method (`GET /applications`).

   3. Enter values for the parameters or leave them all blank.

   4. Click **Try It Out**.

   ### Result:

   The request Uniform Resource Locator (URL) *(tooltip: \<div class="paragraph">
   \<p>Identifies a resource according to its internet location.\</p>
   \</div>)*, response body, response code, and response headers display.