---
title: Catalog.Aptimizer.Profile
slug: ps/help/en_us/vtm/controlapi/catalogaptimizerprofile
docTags: 
createdAt: 2026-08-02T08:52:22.866Z
---

URI: http\://soap.zeus.com/zxtm/1.0/Catalog/Aptimizer/Profile/

The Catalog.Aptimizer.Profile interface allows management of Web Accelerator profiles. Using this interface, you can create, delete and rename Web Accelerator profiles, and manage their configuration.

### Methods

### getAptimizerProfileNames() throws LicenseError

Get the names of all the configured Web Accelerator profiles.

```bash
String[] getAptimizerProfileNames()
```

### getBackgroundAfter( profile\_names ) throws ObjectDoesNotExist, LicenseError

Get after how many milliseconds Web Accelerator should return the original server content to the client and continue optimizing data in the background.

```bash
Unsigned Integer[] getBackgroundAfter(
String[] profile_names
)
```

### getBackgroundAfterByLocation( location, profile\_names ) throws ObjectDoesNotExist, LicenseError

Get after how many milliseconds Web Accelerator should return the original server content to the client and continue optimizing data in the background. This is a location specific function, any action will operate on the specified location.

```bash
Unsigned Integer[] getBackgroundAfterByLocation(
String location
String[] profile_names
)
```

### getBackgroundOnAdditionalResources( profile\_names ) throws ObjectDoesNotExist, LicenseError

Get whether or not Web Accelerator should fetch and optimize additional resources in the background and send partially optimized content to clients until all resources are ready.

```bash
Boolean[] getBackgroundOnAdditionalResources(
String[] profile_names
)
```

### getBackgroundOnAdditionalResourcesByLocation( location, profile\_names ) throws ObjectDoesNotExist, LicenseError

Get whether or not Web Accelerator should fetch and optimize additional resources in the background and send partially optimized content to clients until all resources are ready. This is a location specific function, any action will operate on the specified location.

```bash
Boolean[] getBackgroundOnAdditionalResourcesByLocation(
String location
String[] profile_names
)
```

### getConfig( profile\_names ) throws ObjectDoesNotExist, LicenseError

Get the configuration string for the Web Accelerator profile.

```bash
String[] getConfig(
String[] profile_names
)
```

### getConfigByLocation( location, profile\_names ) throws ObjectDoesNotExist, LicenseError

Get the configuration string for the Web Accelerator profile. This is a location specific function, any action will operate on the specified location.

```bash
String[] getConfigByLocation(
String location
String[] profile_names
)
```

### getMode( profile\_names ) throws ObjectDoesNotExist, LicenseError

Get the mode in which Web Accelerator should run when this profile is applied

```bash
Catalog.Aptimizer.Profile.Mode[] getMode(
String[] profile_names
)
```

### getModeByLocation( location, profile\_names ) throws ObjectDoesNotExist, LicenseError

Get the mode in which Web Accelerator should run when this profile is applied This is a location specific function, any action will operate on the specified location.

```bash
Catalog.Aptimizer.Profile.Mode[] getModeByLocation(
String location
String[] profile_names
)
```

### getShowInfoBar( profile\_names ) throws ObjectDoesNotExist, LicenseError

Get whether or not the Web Accelerator information bar should be displayed on accelerated web pages

```bash
Boolean[] getShowInfoBar(
String[] profile_names
)
```

### getShowInfoBarByLocation( location, profile\_names ) throws ObjectDoesNotExist, LicenseError

Get whether or not the Web Accelerator information bar should be displayed on accelerated web pages This is a location specific function, any action will operate on the specified location.

```bash
Boolean[] getShowInfoBarByLocation(
String location
String[] profile_names
)
```

### setBackgroundAfter( profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set after how many milliseconds Web Accelerator should return the original server content to the client and continue optimizing data in the background.

```bash
void setBackgroundAfter(
String[] profile_names
Unsigned Integer[] values
)
```

### setBackgroundAfterByLocation( location, profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set after how many milliseconds Web Accelerator should return the original server content to the client and continue optimizing data in the background. This is a location specific function, any action will operate on the specified location.

```bash
void setBackgroundAfterByLocation(
String location
String[] profile_names
Unsigned Integer[] values
)
```

### setBackgroundOnAdditionalResources( profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set whether or not Web Accelerator should fetch and optimize additional resources in the background and send partially optimized content to clients until all resources are ready.

```bash
void setBackgroundOnAdditionalResources(
String[] profile_names
Boolean[] values
)
```

### setBackgroundOnAdditionalResourcesByLocation( location, profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set whether or not Web Accelerator should fetch and optimize additional resources in the background and send partially optimized content to clients until all resources are ready. This is a location specific function, any action will operate on the specified location.

```bash
void setBackgroundOnAdditionalResourcesByLocation(
String location
String[] profile_names
Boolean[] values
)
```

### setConfig( profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set the configuration string for the Web Accelerator profile.

```bash
void setConfig(
String[] profile_names
String[] values
)
```

### setConfigByLocation( location, profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set the configuration string for the Web Accelerator profile. This is a location specific function, any action will operate on the specified location.

```bash
void setConfigByLocation(
String location
String[] profile_names
String[] values
)
```

### setMode( profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set the mode in which Web Accelerator should run when this profile is applied

```bash
void setMode(
String[] profile_names
Catalog.Aptimizer.Profile.Mode[] values
)
```

### setModeByLocation( location, profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set the mode in which Web Accelerator should run when this profile is applied This is a location specific function, any action will operate on the specified location.

```bash
void setModeByLocation(
String location
String[] profile_names
Catalog.Aptimizer.Profile.Mode[] values
)
```

### setShowInfoBar( profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set whether or not the Web Accelerator information bar should be displayed on accelerated web pages

```bash
void setShowInfoBar(
String[] profile_names
Boolean[] values
)
```

### setShowInfoBarByLocation( location, profile\_names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError, LicenseError

Set whether or not the Web Accelerator information bar should be displayed on accelerated web pages This is a location specific function, any action will operate on the specified location.

```bash
void setShowInfoBarByLocation(
String location
String[] profile_names
Boolean[] values
)
```

### Enumerations

### Catalog.Aptimizer.Profile.Mode

```bash
enum Catalog.Aptimizer.Profile.Mode {
# Off - Acceleration is disabled, but requests for Web Accelerator resources
# are served
idle,
# Stealth - Acceleration is controlled by a cookie
stealth,
# On - Web Accelerator acceleration is enabled
active
}
```