List metadata query indices

v1.0.0

Retrieves the metadata query indices for a given scope and template key.

Input

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "global",
        "enterprise"
      ]
    },
    "template_key": {
      "type": "string"
    }
  },
  "required": [
    "scope",
    "template_key"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "A collection of metadata query indices.",
  "properties": {
    "entries": {
      "type": "array",
      "description": "A collection of metadata query indices.",
      "items": {
        "type": "object",
        "description": "A metadata query index",
        "required": [
          "type",
          "status"
        ],
        "properties": {
          "fields": {
            "type": "array",
            "description": "A list of template fields which make up the index.",
            "items": {
              "type": "object",
              "description": "The field which makes up the index."
            }
          },
          "id": {
            "type": "string",
            "description": "The ID of the metadata query index."
          },
          "status": {
            "type": "string",
            "description": "The status of the metadata query index",
            "enum": [
              "building",
              "active",
              "disabled"
            ]
          },
          "type": {
            "type": "string",
            "description": "Value is always `metadata_query_index`"
          }
        }
      }
    },
    "limit": {
      "type": "integer",
      "format": "int64",
      "description": "The limit that was used for this request."
    },
    "next_marker": {
      "type": "string",
      "description": "The marker for the start of the next page of results."
    }
  }
}