Schemas

A list of errors which occurred during a profile request.

Identifies the ICAP Profile. The name should consist of only alphanumeric characters [A-Za-z0-9].

Identifies the version of the ICAP Profile.

Identifies the policy. The name should consist of only alphanumeric characters [A-Za-z0-9].

Identifies the actions to be carried out - block: Blocks content - bypass: Enables content to skip the CDR process - process: Identifies content that must be rebuilt by CDR

Maps MIME types to the required processing action.

Identifies the ICAP Profile. The name should consist of only alphanumeric characters [A-Za-z0-9].

Identifies the version of the ICAP Profile.

Status indicates whether ICAP Profile can be actively used.

The settings that are applied when the ICAP Policy is used.

The settings that are applied when the ICAP Policy is used.

Status indicates whether ICAP Profile can be actively used.

Identifies the schema and its version. The format should be in the format of [name]v[version], consisting of only alphanumeric characters [A-Za-z0-9].

Identifies the policy. The name should consist of only alphanumeric characters [A-Za-z0-9].

Identifies the version of the ICAP Profile.

Status indicates whether ICAP Profile can be actively used.

The ICAP service header returned on every response.

The OPTIONS TTL in seconds.

The maximum size of the response cache in megabytes.

Whether responses are cached. Follows the cache size rather than being set separately: caching is on whenever the maximum size is greater than zero.

The processing timeout, as a duration.

The console log level.

Whether the mutual-TLS listener is enabled. While it is off the server does not bind the TLS port at all. Changing it takes effect on the next ICAP server restart.

The port the server listens on. Set during appliance setup; cannot be changed here.

The port the mutual-TLS listener binds. Set during appliance setup; cannot be changed here.

The address the server binds to. Set at deployment; cannot be changed here.

What can be said about the server certificate without disclosing it. The certificate and its private key are provisioned outside the web tier and are never returned.

Whether an administrator has saved these settings through the portal or this API. True after a save that pinned nothing, because the appliance records the save itself, so this does not mean any value is overridden. Read from the settings store on every read.

The stored settings the ICAP server has not picked up yet, named as this schema names them. Empty where everything stored is in force. A setting applied live reaches the server when its mounted configuration resyncs, inside a minute, so a read taken in that window reports the value still in effect; this says which values are waiting, so a caller can tell a save that has not landed yet from one that failed. Mutual TLS never appears: it binds a listener at startup, so it applies on the next restart rather than by propagation.

Whether usable certificate material is loaded.

The certificate subject, when one is loaded.

When the certificate expires, when one is loaded.

The ICAP service header, 1 to 255 printable ASCII characters and not only whitespace. The value is written verbatim into response headers, which are ASCII, so anything outside that range either injects a header or changes how one renders.

The OPTIONS TTL in seconds, up to an hour. A peer honouring the TTL does not renegotiate until it expires, so a longer one pins the behaviour a client believes this server has.

The maximum size of the response cache in megabytes. Zero turns caching off. Cannot exceed 10000000, nor the space available on the volume backing the cache.

The processing timeout, between one second and ten minutes, as hh:mm:ss. Must carry a colon: a bare number is refused, because it is a valid duration meaning that many days, so 10 from a caller who meant ten seconds would otherwise be stored as ten days. Note that a two-part value is read as hours and minutes, so 01:40 is one hour forty and outside the range — write 00:01:40.

The console log level.

Whether the mutual-TLS listener is enabled. Applies on the next ICAP server restart, not immediately.

The port the server listens on.

The port the mutual-TLS listener binds.

The address the server binds to.

Whether the mutual-TLS listener is enabled.

The ICAP service header the server returns.

The OPTIONS TTL in seconds.

Whether the listener answered both requests.

The classification of what the probe found. A caller that does not recognise a value should fall back to reason.

A short summary of the outcome.

The address the probe connected to.

The port the probe connected to.

The number of seconds the probe was bounded by.

The ICAP status the OPTIONS request was answered with, where it was answered.

Whether the appliance is answering ICAP requests. True only once a replica is ready, so a server that is still starting reads false.

How many replicas the deployment has been asked for. The portal sets this to 0 or 1.

How many replicas are ready to serve.

Whether the desired and ready counts disagree - a server that is starting or stopping. Poll until this is false before treating the state as settled.

Whether an autoscaler owns the replica count on this installation. It does not settle whether the server can be started and stopped - read changeable for that.

Whether this installation can start and stop the server. False where it was deployed without permission to change it, and where an autoscaler owns the count that the appliance may not pause; a change is refused in both cases. Where an autoscaler is present and can be paused this is true, and starting and stopping go through the autoscaler rather than around it, so nothing is reverted underneath.

Whether the ICAP server should be running. Required - a body that omits it is refused rather than read as false, so a malformed request cannot stop ICAP by accident.