Skip to navigation

List available Locations

Listing, Sorting and Filtering Locations

This endpoint returns the list of locations.

Sorting

The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas where each one can optionally specify asc or desc.

Sorting is valid on the following fields: displayName, id, name

Filtering

The $filter query parameter allows for locations to be filtered on the basis of fields in the schema using OData query syntax. See this document for more details on the syntax used.

Filters are valid on the following fields: cloud/name, cloud/region/name, displayName, id, name

Examples:

?$top=10 - Returns only the first 10 locations from the list.

?$orderby=name desc - Sorts locations by name in descending order.

?$filter=name eq 'descriptive name' - Returns locations that match the provided name.

RBAC Capability Required: core.location.get

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

$orderbystringOptional
Specifies the key by which the result collection should be ordered.
$filterstringOptional
Restricts the set of items returned.
$topstringOptional

Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

$skiptokenstringOptional

Specifies a start offset to support paginated results. Use @odata.nextLink in the result object to enumerate the collection - it will be present only if there's more than one page of entities.

Response

A list of locations
valuelist of objects
A list of Locations
kindstringOptionalRead-only
The type of the resource.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error