---
title: Location
slug: ps/help/en_us/vtm/controlapi/location
docTags: 
createdAt: 2026-08-02T08:52:22.801Z
---

URI: http\://soap.zeus.com/zxtm/1.0/Location/

The Location interface allows management of traffic manager locations. Using this interface, you can create, delete and rename Locations, and manage their configuration.

### Methods

### addLocation( locations, info ) throws ObjectAlreadyExists, ObjectDoesNotExist, InvalidObjectName, InvalidInput, DeploymentError, LicenseError, InvalidOperation

Adds locations. Configuration for the new locations will be based on the specified locations

```bash
void addLocation(
String[] locations
Location.TypeInfo[] info
)
```

### deleteLocation( locations ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError, LicenseError

Delete the named Location.

```bash
void deleteLocation(
String[] locations
)
```

### disable( location ) throws InvalidInput, ObjectDoesNotExist, LicenseError

Disable support for configuration locations, setting all configuration values to those for the specified location.

```bash
void disable(
String location
)
```

### enable() throws LicenseError, InvalidOperation

Enable support for configuration locations.

```bash
void enable()
```

### getCoordinates( locations ) throws ObjectDoesNotExist, LicenseError, InvalidOperation

Get the coordinates for the named locations.

```bash
Location.Coordinates[] getCoordinates(
String[] locations
)
```

### getLocations()

Get the names of all the configured locations.

```bash
String[] getLocations()
```

### getNote( locations ) throws ObjectDoesNotExist, LicenseError, InvalidOperation

Get the note for each of the named locations

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

### getTrafficManagerLocation( traffic\_managers ) throws ObjectDoesNotExist, LicenseError

Gets the location that the named traffic managers are in.

```bash
String[] getTrafficManagerLocation(
String[] traffic_managers
)
```

### getType( locations ) throws ObjectDoesNotExist, LicenseError, InvalidOperation

Gets a location's type, either config or glb. GLB locations contain no traffic managers, and are only used for global load balancing.

```bash
String[] getType(
String[] locations
)
```

### renameLocation( locations, new\_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, LicenseError

Rename the named Locations.

```bash
void renameLocation(
String[] locations
String[] new_names
)
```

### setCoordinates( locations, coordinates ) throws ObjectDoesNotExist, DeploymentError, LicenseError, InvalidOperation

Set the coordinates for the named locations. Coordinates are only needed for global load balancing.

```bash
void setCoordinates(
String[] locations
Location.Coordinates[] coordinates
)
```

### setNote( locations, values ) throws ObjectDoesNotExist, DeploymentError, LicenseError, InvalidOperation

Set the note for each of the named locations

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

### setTrafficManagerLocation( traffic\_managers, locations ) throws ObjectDoesNotExist, LicenseError, DeploymentError, InvalidOperation

Sets the location that the named traffic managers are in.

```bash
void setTrafficManagerLocation(
String[] traffic_managers
String[] locations
)
```

### setType( locations, type\_info ) throws ObjectInUse, ObjectDoesNotExist, LicenseError, InvalidInput, InvalidOperation

Sets a location's type, either config or glb. GLB locations contain no traffic managers, and are only used for global load balancing.

```bash
void setType(
String[] locations
Location.TypeInfo[] type_info
)
```

### Structures

### Location.Coordinates

This structure contains the co-ordinates for a location.

```bash
struct Location.Coordinates {
# The longitude of the location.
Double longitude;
# The latitude of the location.
Double latitude;
}
```

### Location.TypeInfo

This structure contains information required when adding a location.

```bash
struct Location.TypeInfo {
# Location type, either config or glb. GLB locations don't contain any
# traffic managers and are used for global load balancing.
String type;
# If the location isn't of type GLB, this is the location that the
# configuration will be be based on initially
String based_on;
}
```