HttpClientInstance
Realm Operations
Resource path:
/realm-config/services/httpclient/instances
Resource version: 2.0
create
Usage
am> create HttpClientInstance --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "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" : "" }, "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" : "" }, "mtlsServerTrustCertsSecretPurpose" : { "title" : "Server Trust Certificates Secret Label Identifier", "description" : "AM uses this identifier to create a specific secret label, using the template <code>am.services.httpclient.mtls.servertrustcerts.{{identifier}}.secret</code> where {{identifier}} is the Secret Label Identifier. <br> The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. <br> 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" : "" }, "mtlsClientCertSecretPurpose" : { "title" : "Client Certificate Secret Label Identifier", "description" : "AM uses this identifier to create a specific secret label, using the template <code>am.services.httpclient.mtls.clientcert.{{identifier}}.secret</code> where {{identifier}} is the Secret Label Identifier. <br> The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. <br> 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" : "" } } }, "timeouts" : { "type" : "object", "title" : "Timeouts", "propertyOrder" : 2, "properties" : { "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" : "" }, "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" : "" }, "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 HttpClientInstance --realm Realm --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 HttpClientInstance --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action HttpClientInstance --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action HttpClientInstance --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query HttpClientInstance --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read HttpClientInstance --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update HttpClientInstance --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "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" : "" }, "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" : "" }, "mtlsServerTrustCertsSecretPurpose" : { "title" : "Server Trust Certificates Secret Label Identifier", "description" : "AM uses this identifier to create a specific secret label, using the template <code>am.services.httpclient.mtls.servertrustcerts.{{identifier}}.secret</code> where {{identifier}} is the Secret Label Identifier. <br> The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. <br> 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" : "" }, "mtlsClientCertSecretPurpose" : { "title" : "Client Certificate Secret Label Identifier", "description" : "AM uses this identifier to create a specific secret label, using the template <code>am.services.httpclient.mtls.clientcert.{{identifier}}.secret</code> where {{identifier}} is the Secret Label Identifier. <br> The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. <br> 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" : "" } } }, "timeouts" : { "type" : "object", "title" : "Timeouts", "propertyOrder" : 2, "properties" : { "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" : "" }, "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" : "" }, "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" : "" } } } } }