Skip to main content

URL query parameter and operators

Thread solved
Beginner
Posts: 1
Comments: 2

Hello,

I can't find the documentation for the query parameters. The documentation say in the "Requests and response" section: "In some cases, endpoint URLs may be complemented with query parameters." [https://developer.acronis.com/doc/tasks/v2/guide/overview/reqres] linked to a mozilla dev page that says "the only reliable way to know how a specific Web server is handling parameters is by asking the Web server owner."

I found some examples on the github page, but is there a list of allowed comparison operators so I don't have to figure them out by trial and error?

Already thank you very much.

0 Users found this helpful
Acronis engineer
Posts: 0
Comments: 84

Hello Tim,

Thank you for your post.

Under each separate API page, you'll find the Reference button on the top banner where all the available Endpoints are referenced with complete details, including the accepted different query URL parameters, and in-Body parameters for each endpoint. It's Guide where we have flows and examples for most commonly used functionalities in Python, and Reference with the endpoints. Some API pages don't have the Python Guide examples, they directly lead to Endpoints.

Here is direct link (accessed from the Reference button), to the Account Management APIv2 endpoints, they are structured in groups as how we defined the different functionalities and methods we offer in the public API: https://developer.acronis.com/doc/account-management/v2/reference/index

Let us know if the topic is solved and if this is what you were looking for.

Thank you.

Beginner
Posts: 1
Comments: 2

Hello Ivaylo,

thank you for the Informations.

To specify my question with an example (github: get_all_alerts_for_the_last_week.ps1):

>> $allLastWeekAlerts = Acronis-Get -Uri "api/alert_manager/v1/alerts?updated_at=gt(${weekAgo})&order=desc(created_at)"

Here we have gt for "greater than" and in other examples there are other operators.
Is there a list for those operators that I missed in the documentation?

Thank you.

Acronis engineer
Posts: 0
Comments: 84

Hello Tim,

Thank you for your reply.

Sure, we have them documented, I only shared link to the Account Management APIv2.

We have the same Reference pages with endpoints for all our separate public APIs.
Main documentation page is: https://developer.acronis.com/doc/

From there you navigate to the separate APIs, where Alerts API is under the Platform Core section. About your question, all about this endpoint is at: https://developer.acronis.com/doc/alerts/v1/reference/index#/http/api-e…

You will find listed operators for "updated_at", "created_at" and "deleted_at" query parameters.

Let me know here in the thread should you need something else specific.

Beginner
Posts: 1
Comments: 2

Hello Ivaylo,

thank you very much. This is exactly what i was looking for.