Skip to content

Update Tags API Documentation #33260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Tags API Documentation #33260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions config/_default/menus/api.en.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4194,7 +4194,7 @@ menu:
- CreateHostTags
unstable: []
order: 3
- name: Get host tags
- name: Get Host Tags
url: '#get-host-tags'
identifier: tags-get-host-tags
parent: tags
Expand All @@ -4218,9 +4218,9 @@ menu:
- DeleteHostTags
unstable: []
order: 5
- name: Get Tags
url: '#get-tags'
identifier: tags-get-tags
- name: Get All Host Tags
url: '#get-all-host-tags'
identifier: tags-get-all-host-tags
parent: tags
generated: true
params:
Expand Down
10 changes: 5 additions & 5 deletions content/en/api/v1/dashboards/examples.json
View file
Open in desktop

Large diffs are not rendered by default.

112 changes: 112 additions & 0 deletions content/en/api/v1/dashboards/request.CreateDashboard_9836563.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
{
"title": "Example-Dashboard",
"description": "Example-Dashboard",
"widgets": [
{
"definition": {
"title": "Log Count by Service and Source",
"type": "geomap",
"requests": [
{
"response_format": "scalar",
"queries": [
{
"data_source": "rum",
"name": "query1",
"search": {
"query": "@type:session"
},
"indexes": [
"*"
],
"compute": {
"aggregation": "count"
},
"group_by": []
}
],
"conditional_formats": [
{
"comparator": ">",
"value": 1000,
"palette": "white_on_green"
}
],
"formulas": [
{
"formula": "query1"
}
],
"sort": {
"count": 250,
"order_by": [
{
"type": "formula",
"index": 0,
"order": "desc"
}
]
}
},
{
"response_format": "event_list",
"query": {
"data_source": "logs_stream",
"query_string": "",
"indexes": [],
"storage": "hot"
},
"columns": [
{
"field": "@network.client.geoip.location.latitude",
"width": "auto"
},
{
"field": "@network.client.geoip.location.longitude",
"width": "auto"
},
{
"field": "@network.client.geoip.country.iso_code",
"width": "auto"
},
{
"field": "@network.client.geoip.subdivision.name",
"width": "auto"
}
],
"style": {
"color_by": "status"
},
"text_formats": [
{
"match": {
"type": "is",
"value": "error"
},
"palette": "white_on_red"
}
]
}
],
"style": {
"palette": "hostmap_blues",
"palette_flip": false
},
"view": {
"focus": "NORTH_AMERICA"
}
},
"layout": {
"x": 0,
"y": 0,
"width": 12,
"height": 6
}
}
],
"template_variables": [],
"layout_type": "ordered",
"notify_list": [],
"reflow_type": "fixed",
"tags": []
}
59 changes: 54 additions & 5 deletions content/en/api/v1/dashboards/widgets.json
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions content/en/api/v1/tags/examples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
]
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tags</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">&lt;any-key&gt;</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of additional properties for tags.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tags</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>A mapping of tags to host names</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">&lt;any-key&gt;</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of host names which contain this tag</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
},
"403": {
"json": {
Expand Down Expand Up @@ -84,7 +84,7 @@
"environment:production"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"403": {
"json": {
Expand Down Expand Up @@ -126,7 +126,7 @@
"environment:production"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"403": {
"json": {
Expand Down Expand Up @@ -173,7 +173,7 @@
"environment:production"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"403": {
"json": {
Expand Down
5 changes: 5 additions & 0 deletions data/api/v1/CodeExamples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,11 @@
"suffix": "_3513586382",
"description": "Create a geomap widget using an event_list request"
},
{
"group": "dashboards",
"suffix": "_9836563",
"description": "Create a geomap widget with conditional formats and text formats"
},
{
"group": "dashboards",
"suffix": "",
Expand Down
Loading
Loading