GuidesChangelogData Inspector Library API Reference
Guides

ratelimit endpoint

ratelimit endpoint

The OLP CLI supports the following functionality for managing rate limit endpoints:

  • list rate limit endpoints
  • show rate limit endpoint

list

Lists all rate limit endpoints.

olp ratelimit endpoint list

Optional parameters:

  • --limit <max number of endpoints> Limits the number of results returned.
  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the HERE platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the command result in JSON format.
  • --quiet Displays the endpoints IDs, each on a new line.

For more information on using credentials and profiles, see Credentials setup.

Example: Get the list of endpoints with their metadata, that are subject to the rate limiting rules:

olp ratelimit endpoint list

Output:

endpoint ID       URL
search-geoCode    https://geocode.search.hereapi.com
routing-svc       https://router.hereapi.com

show

Show rate limit endpoint associated with specific endpointId.

olp ratelimit endpoint show [command parameters]

Required parameters:

  • <endpointId> - The ID of the endpoint to get information about.

Optional parameters:

  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the HERE platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the command result in JSON format.
  • --quiet Displays the endpoints IDs, each on a new line.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below shows rate limit endpoint info for provided endpointId:

olp ratelimit endpoint show search-geoCode

Output:

endpoint ID       search-geoCode
URL               https://geocode.search.hereapi.com