---
title: Catalog.Rate
slug: ps/help/en_us/vtm/controlapi/catalograte
docTags: 
createdAt: 2026-08-02T08:52:21.994Z
---

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

The Catalog.Rate interface allows management of Rate classes. Using this interface, you can create, delete and rename rate classes, and manage their configuration.

### Methods

### addRate( class\_names ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError

Add new rate classes.

```bash
void addRate(
String[] class_names
)
```

### copyRate( class\_names, new\_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError

Copy the named rate classes.

```bash
void copyRate(
String[] class_names
String[] new_names
)
```

### deleteRate( class\_names ) throws ObjectInUse, ObjectDoesNotExist, DeploymentError

Delete the named rate classes.

```bash
void deleteRate(
String[] class_names
)
```

### getMaxRatePerMinute( class\_names ) throws ObjectDoesNotExist

Get the maximum rate at which requests are allowed to be processed, in requests per minute.

```bash
Unsigned Integer[] getMaxRatePerMinute(
String[] class_names
)
```

### getMaxRatePerMinuteByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the maximum rate at which requests are allowed to be processed, in requests per minute. This is a location specific function, any action will operate on the specified location.

```bash
Unsigned Integer[] getMaxRatePerMinuteByLocation(
String location
String[] class_names
)
```

### getMaxRatePerSecond( class\_names ) throws ObjectDoesNotExist

Get the maximum rate at which requests are allowed to be processed, in requests per second.

```bash
Unsigned Integer[] getMaxRatePerSecond(
String[] class_names
)
```

### getMaxRatePerSecondByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the maximum rate at which requests are allowed to be processed, in requests per second. This is a location specific function, any action will operate on the specified location.

```bash
Unsigned Integer[] getMaxRatePerSecondByLocation(
String location
String[] class_names
)
```

### getNote( class\_names ) throws ObjectDoesNotExist

Get the note for each of the named Rate classes.

```bash
String[] getNote(
String[] class_names
)
```

### getRateNames()

Get the names of all the configured rate classes.

```bash
String[] getRateNames()
```

### renameRate( class\_names, new\_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidOperation

Rename the named rate classes.

```bash
void renameRate(
String[] class_names
String[] new_names
)
```

### setMaxRatePerMinute( class\_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the maximum rate at which requests are allowed to be processed, in requests per minute.

```bash
void setMaxRatePerMinute(
String[] class_names
Unsigned Integer[] values
)
```

### setMaxRatePerMinuteByLocation( location, class\_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the maximum rate at which requests are allowed to be processed, in requests per minute. This is a location specific function, any action will operate on the specified location.

```bash
void setMaxRatePerMinuteByLocation(
String location
String[] class_names
Unsigned Integer[] values
)
```

### setMaxRatePerSecond( class\_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the maximum rate at which requests are allowed to be processed, in requests per second.

```bash
void setMaxRatePerSecond(
String[] class_names
Unsigned Integer[] values
)
```

### setMaxRatePerSecondByLocation( location, class\_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the maximum rate at which requests are allowed to be processed, in requests per second. This is a location specific function, any action will operate on the specified location.

```bash
void setMaxRatePerSecondByLocation(
String location
String[] class_names
Unsigned Integer[] values
)
```

### setNote( class\_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the note for each of the named Rate classes.

```bash
void setNote(
String[] class_names
String[] values
)
```