---
title: HttpClientInstanceConfiguration
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-httpclientinstanceconfiguration
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-httpclientinstanceconfiguration.html
section_ids:
sec-amster-entity-httpclientinstanceconfiguration-global-ops: Global Operations
sec-amster-entity-httpclientinstanceconfiguration-global-ops-create: create
sec-amster-entity-httpclientinstanceconfiguration-global-ops-delete: delete
sec-amster-entity-httpclientinstanceconfiguration-global-ops-getalltypes: getAllTypes
sec-amster-entity-httpclientinstanceconfiguration-global-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-httpclientinstanceconfiguration-global-ops-nextdescendents: nextdescendents
sec-amster-entity-httpclientinstanceconfiguration-global-ops-query: query
sec-amster-entity-httpclientinstanceconfiguration-global-ops-read: read
sec-amster-entity-httpclientinstanceconfiguration-global-ops-update: update
---
# HttpClientInstanceConfiguration
## Global Operations
Resource path:
```
/global-config/services/httpclient/instances
```
Resource version: `1.0`
### create
**Usage**
```
am> create HttpClientInstanceConfiguration --global --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"tls" : {
"type" : "object",
"title" : "TLS Configuration",
"propertyOrder" : 1,
"properties" : {
"disableRevocationChecks" : {
"title" : "Disable Certificate Revocation Check",
"description" : "If enabled, certificate revocation checks will be disabled when performing a TLS connection with the target server.",
"propertyOrder" : 310,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"mtlsServerTrustCertsSecretPurpose" : {
"title" : "Server Trust Certificates Secret Label Identifier",
"description" : "AM uses this identifier to create a specific secret label, using the template am.services.httpclient.mtls.servertrustcerts.{{identifier}}.secret where {{identifier}} is the Secret Label Identifier.
The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.
If this field is not populated, then the system truststore will be used when attempting to verify the target server's certificate during a TLS connection.",
"propertyOrder" : 300,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"trustAllCertificates" : {
"title" : "Trust All Certificates",
"description" : "If enabled, all certificates will be trusted when performing a TLS connection with the target server. This is useful for testing purposes, but should not be used in a production environment.",
"propertyOrder" : 320,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"mtlsClientCertSecretPurpose" : {
"title" : "Client Certificate Secret Label Identifier",
"description" : "AM uses this identifier to create a specific secret label, using the template am.services.httpclient.mtls.clientcert.{{identifier}}.secret where {{identifier}} is the Secret Label Identifier.
The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.
If this field is not populated, then no client certificate will be presented when performing a TLS connection with the target server.",
"propertyOrder" : 200,
"required" : false,
"type" : "string",
"exampleValue" : ""
}
}
},
"proxy" : {
"type" : "object",
"title" : "Proxy Configuration",
"propertyOrder" : 3,
"properties" : {
"proxySecretLabelIdentifier" : {
"title" : "Proxy Secret Label Identifier",
"description" : "AM uses this identifier to create a specific secret label, using the template am.services.httpclient.proxy.{{identifier}}.secret where {{identifier}} is the Secret Label Identifier.
The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.
If this field is not populated, then no proxy authentication will be performed.",
"propertyOrder" : 1000,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"useInstanceProxy" : {
"title" : "Use Instance Proxy",
"description" : "If enabled, the proxy settings defined in this instance will be used. If disabled, the proxy settings defined in the Server Advanced properties for http client connections will be used.",
"propertyOrder" : 700,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"proxyUri" : {
"title" : "Proxy URI",
"description" : "The URI of the proxy server to use for HTTP requests. The format of the URI should be http://hostname:port or https://hostname:port.",
"propertyOrder" : 800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"proxyUsername" : {
"title" : "Proxy Username",
"description" : "The username to use for proxy authentication, if required.",
"propertyOrder" : 900,
"required" : false,
"type" : "string",
"exampleValue" : ""
}
}
},
"timeouts" : {
"type" : "object",
"title" : "Timeouts",
"propertyOrder" : 2,
"properties" : {
"useInstanceTimeouts" : {
"title" : "Use Instance Timeouts",
"description" : "If enabled, the connection and response timeouts defined in this instance will be used. If disabled, the timeouts defined in the Server Advanced properties for http client connections will be used.",
"propertyOrder" : 400,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"connectionTimeout" : {
"title" : "Connection Timeout (secs)",
"description" : "The maximum time (in seconds) to wait for a connection to be established before failing.",
"propertyOrder" : 500,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"responseTimeout" : {
"title" : "Response Timeout (secs)",
"description" : "The maximum time (in seconds) to wait for a response from the target server before failing.",
"propertyOrder" : 600,
"required" : true,
"type" : "integer",
"exampleValue" : ""
}
}
},
"core" : {
"type" : "object",
"title" : "Configuration",
"propertyOrder" : 0,
"properties" : {
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables this Http Client instance.",
"propertyOrder" : 2,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
}
}
}
```
### delete
**Usage**
```
am> delete HttpClientInstanceConfiguration --global --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action HttpClientInstanceConfiguration --global --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action HttpClientInstanceConfiguration --global --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action HttpClientInstanceConfiguration --global --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query HttpClientInstanceConfiguration --global --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read HttpClientInstanceConfiguration --global --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update HttpClientInstanceConfiguration --global --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"tls" : {
"type" : "object",
"title" : "TLS Configuration",
"propertyOrder" : 1,
"properties" : {
"disableRevocationChecks" : {
"title" : "Disable Certificate Revocation Check",
"description" : "If enabled, certificate revocation checks will be disabled when performing a TLS connection with the target server.",
"propertyOrder" : 310,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"mtlsServerTrustCertsSecretPurpose" : {
"title" : "Server Trust Certificates Secret Label Identifier",
"description" : "AM uses this identifier to create a specific secret label, using the template am.services.httpclient.mtls.servertrustcerts.{{identifier}}.secret where {{identifier}} is the Secret Label Identifier.
The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.
If this field is not populated, then the system truststore will be used when attempting to verify the target server's certificate during a TLS connection.",
"propertyOrder" : 300,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"trustAllCertificates" : {
"title" : "Trust All Certificates",
"description" : "If enabled, all certificates will be trusted when performing a TLS connection with the target server. This is useful for testing purposes, but should not be used in a production environment.",
"propertyOrder" : 320,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"mtlsClientCertSecretPurpose" : {
"title" : "Client Certificate Secret Label Identifier",
"description" : "AM uses this identifier to create a specific secret label, using the template am.services.httpclient.mtls.clientcert.{{identifier}}.secret where {{identifier}} is the Secret Label Identifier.
The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.
If this field is not populated, then no client certificate will be presented when performing a TLS connection with the target server.",
"propertyOrder" : 200,
"required" : false,
"type" : "string",
"exampleValue" : ""
}
}
},
"proxy" : {
"type" : "object",
"title" : "Proxy Configuration",
"propertyOrder" : 3,
"properties" : {
"proxySecretLabelIdentifier" : {
"title" : "Proxy Secret Label Identifier",
"description" : "AM uses this identifier to create a specific secret label, using the template am.services.httpclient.proxy.{{identifier}}.secret where {{identifier}} is the Secret Label Identifier.
The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.
If this field is not populated, then no proxy authentication will be performed.",
"propertyOrder" : 1000,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"useInstanceProxy" : {
"title" : "Use Instance Proxy",
"description" : "If enabled, the proxy settings defined in this instance will be used. If disabled, the proxy settings defined in the Server Advanced properties for http client connections will be used.",
"propertyOrder" : 700,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"proxyUri" : {
"title" : "Proxy URI",
"description" : "The URI of the proxy server to use for HTTP requests. The format of the URI should be http://hostname:port or https://hostname:port.",
"propertyOrder" : 800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"proxyUsername" : {
"title" : "Proxy Username",
"description" : "The username to use for proxy authentication, if required.",
"propertyOrder" : 900,
"required" : false,
"type" : "string",
"exampleValue" : ""
}
}
},
"timeouts" : {
"type" : "object",
"title" : "Timeouts",
"propertyOrder" : 2,
"properties" : {
"useInstanceTimeouts" : {
"title" : "Use Instance Timeouts",
"description" : "If enabled, the connection and response timeouts defined in this instance will be used. If disabled, the timeouts defined in the Server Advanced properties for http client connections will be used.",
"propertyOrder" : 400,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"connectionTimeout" : {
"title" : "Connection Timeout (secs)",
"description" : "The maximum time (in seconds) to wait for a connection to be established before failing.",
"propertyOrder" : 500,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"responseTimeout" : {
"title" : "Response Timeout (secs)",
"description" : "The maximum time (in seconds) to wait for a response from the target server before failing.",
"propertyOrder" : 600,
"required" : true,
"type" : "integer",
"exampleValue" : ""
}
}
},
"core" : {
"type" : "object",
"title" : "Configuration",
"propertyOrder" : 0,
"properties" : {
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables this Http Client instance.",
"propertyOrder" : 2,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
}
}
}
```