Searching via REST API

[nordsan (san)]

Hi,
Which REST API endpoint should be used for searching? /api/search/universal/relative makes sense, but it is listed as “Legacy”. Also, I can’t seem to figure out which roles/permissions my user should have to be granted access to this endpoint. “Admin” works, but “Reader” only returns 403 - I can’t seem to find any Roles that are “in between” Admin and Reader. I’d just like my token to have the permission to search logs.
I also tried using the /api/views/search API and POSTing the following:

{
  "parameters": [],
  "queries": [
    {
      "search_types": [],
      "query": {"type": "elasticsearch","query_string": "*"},
      "timerange": {
        "type": "relative",
        "range": "3000000"
      }
    }
  ]
}

The response contains:

{"id":"63739930527a3b7ac90e10ab","queries":[{"id":"78e13a19-2093-41be-bc92-29b5d31b4fc3", ... }

I can’t seem to understand how to proceed from this. Calling /execute with the same ID returns MissingStreamPermission and GETing /api/views/search/63739930527a3b7ac90e10ab simply returns the same query I sent.

How should I be using search via the REST API? What am I missing?

Thanks

[gsmith]

Hello @nordsan
Lots of questions and I try to answer them best as I can.

@nordsan

/api/search/universal/relative makes sense, but it is listed as “Legacy”.

Chances are when seeing that, it might get replaced or deleted from the API list.

@nordsan

roles/permissions my user should have to be granted access to this endpoint. “Admin” works, but “Reader”

The roles you see under roles that is it.
Example I have a user with "reader " role, Admin has to give permission to individual Streams, Dashboards , etc… This is done through “Shared” button. Kind of like a two step process.

@nordsan

MissingStreamPermission and GETing /api/views/search/63739930527a3b7ac90e10ab simply returns the same query I sent.

There is a user and password need to access the API’s, I do believe this was answered here in the forum a couple times. Short answer I think it admin role needed.

@nordsan

How should I be using search via the REST API? What am I missing?

Not sure but I would look at these links for clarification on Graylog versions.

• Changelog
• https://www.graylog.org/releases/

@nordsan

I also tried using the /api/views/search API and POSTing the following

I think this is the Schema needed for POST.
/api/views/search

{
  "id": "string",
  "parameters": [
    {
      "name": "string",
      "data_type": "string",
      "binding": {
        "type": "string"
      },
      "description": "string",
      "optional": "boolean",
      "default_value": "any",
      "title": "string",
      "type": "string"
    }
  ],
  "queries": [
    {
      "timerange": {
        "type": "string"
      },
      "query": {},
      "streams": [
        "string"
      ],
      "id": "string",
      "search_types": [
        {
          "filter": "object",
          "timerange": "any",
          "query": {},
          "streams": [
            "string"
          ],
          "name": "string",
          "id": "string",
          "type": "string"
        }
      ]
    }
  ]
}