---
title: Using the Configuration API
description: The servers in the PingDirectory suite of products provide a Configuration API to use when updating the configuration with LDAP isn't 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.
component: pingdirectory
version: 11.0
page_id: pingdirectory:pingdirectory_server_administration_guide:pd_ds_use_config_api
canonical_url: https://docs.pingidentity.com/pingdirectory/11.0/pingdirectory_server_administration_guide/pd_ds_use_config_api.html
revdate: July 18, 2024
page_aliases: ["pingdatasync_server_administration_guide:pd_sync_use_config_api.adoc", "pingdirectoryproxy_server_administration_guide:pd_proxy_use_config_api.adoc"]
section_ids:
  steps: Steps
  result: Result:
---

# Using the Configuration API

The servers in the PingDirectory suite of products provide a Configuration API to use when updating the configuration with LDAP isn't possible. The API is consistent with the System for Cross-domain Identity Management (SCIM) *(tooltip: \<div class="paragraph">
\<p>An application-level, HTTP-based protocol for provisioning and managing user identity information. SCIM supplies a common schema for representing users and groups and provides a REST API.\</p>
\</div>)* 2.0 protocol and uses JSON as a text exchange format, so all request headers allow the `application/json` content type.

|   |                                                                                                                                                                                                                                                                                               |
| - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | Unless otherwise specified, the topics in this section apply to PingDirectory, PingDirectoryProxy, and PingDataSync. When a code example refers to the `userRoot` backend, which is only relevant for the PingDirectory server, you can usually adapt the example to use a different backend. |

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.