---
title: Using the Configuration API
description: Use the PingDirectory SCIM 2.0-consistent Configuration API to read and write server configuration over HTTP.
component: pingdirectory
version: 10.2
page_id: pingdirectory:pingdirectory_server_administration_guide:pd_ds_use_config_api
canonical_url: https://docs.pingidentity.com/pingdirectory/11.1/pingdirectory_server_administration_guide/pd_ds_use_config_api.html
llms_txt: https://docs.pingidentity.com/pingdirectory/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
revdate: 2024-07-18T00:00:00Z
superseded_by: https://docs.pingidentity.com/pingdirectory/11.1/pingdirectory_server_administration_guide/pd_ds_use_config_api.html
section_ids:
  about-this-task: About this task
  steps: Steps
  result: Result:
---

# Using the Configuration API

The PingDirectory server provides a Configuration API when updating the server configuration with LDAP is not possible. The API is consistent with the System for Cross-domain Identity Management (SCIM) 2.0 protocol and uses JSON as a text exchange format, so all request headers allow the application/json content type.

## About this task

The server includes a servlet extension that provides read and write access to the server's configuration over HTTP.

## Steps

* To add the extension to one of the server's HTTP Connection Handlers, run the following code.

  ```shell
  $ bin/dsconfig set-connection-handler-prop \
    --handler-name "HTTPS Connection Handler" \
    --add http-servlet-extension:Configuration
  ```

  |   |                                                                                                                    |
  | - | ------------------------------------------------------------------------------------------------------------------ |
  |   | By default, the extension is enabled for new installations. You can enable the extension for existing deployments. |

  ### Result:

  The API is made available on the HTTPS Connection Handler's host:port in the `/config` context. Because of the potentially sensitive nature of the server's configuration, use the HTTPS Connection Handler for hosting the configuration extension.