---
title: HttpClient
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-httpclient
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-httpclient.html
section_ids:
  sec-amster-entity-httpclient-realm-ops: Realm Operations
  sec-amster-entity-httpclient-realm-ops-create: create
  sec-amster-entity-httpclient-realm-ops-delete: delete
  sec-amster-entity-httpclient-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-httpclient-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-httpclient-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-httpclient-realm-ops-read: read
  sec-amster-entity-httpclient-realm-ops-update: update
---

# HttpClient

## Realm Operations

Resource path:

```
/realm-config/services/httpclient
```

Resource version: `0.0`

### create

**Usage**

```
am> create HttpClient --realm Realm --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "core" : {
        "type" : "object",
        "title" : "Configuration",
        "propertyOrder" : 0,
        "properties" : {
          "enabled" : {
            "title" : "Enabled",
            "description" : "Enables or disables this Http Client Service. If disabled, the Http Client instances defined within this service will not be usable. Http requests will instead be made using the default Http Client instance, which is configured using the Server Advanced properties for http client connections.",
            "propertyOrder" : 1,
            "required" : true,
            "type" : "boolean",
            "exampleValue" : ""
          }
        }
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete HttpClient --realm Realm
```

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action HttpClient --realm Realm --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action HttpClient --realm Realm --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action HttpClient --realm Realm --actionName nextdescendents
```

### read

**Usage**

```
am> read HttpClient --realm Realm
```

### update

**Usage**

```
am> update HttpClient --realm Realm --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "core" : {
        "type" : "object",
        "title" : "Configuration",
        "propertyOrder" : 0,
        "properties" : {
          "enabled" : {
            "title" : "Enabled",
            "description" : "Enables or disables this Http Client Service. If disabled, the Http Client instances defined within this service will not be usable. Http requests will instead be made using the default Http Client instance, which is configured using the Server Advanced properties for http client connections.",
            "propertyOrder" : 1,
            "required" : true,
            "type" : "boolean",
            "exampleValue" : ""
          }
        }
      }
    }
  }
  ```