이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우
언제든지 연락주시기 바랍니다.The Screenboard endpoint allows you to programmatically create, update, delete, and query screenboards.
Create a screenboard
Signature
POST https://api.datadoghq.com/api/v1/screen
Arguments
board_title [required]:
The name of the dashboard.description [optional, default=None]:
A description of the dashboard’s content.widgets [required]:
A list of widget definitions. To get a widget definition, use the JSON tab in the widget configuration UI.template_variables [optional, default=None]:
A list of template variables for using Dashboard templating.read_only [optional, default=False]:
The read-only status of the screenboard.
Examples
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
board_title = "My Screenboard"
description = "An informative screenboard."
width = 1024
widgets = [{
"type": "image",
"height": 20,
"width": 32,
"y": 7,
"x": 32,
"url": "https://path/to/image.jpg"
}]
template_variables = [{
"name": "host1",
"prefix": "host",
"default": "host:my-host"
}]
api.Screenboard.create(board_title=board_title,
description=description,
widgets=widgets,
template_variables=template_variables,
width=width)
require 'rubygems'
require 'dogapi'
api_key='<DATADOG_API_KEY>'
app_key='<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
board = {
"width" => 1024,
"height" => 768,
"board_title" => "dogapi test",
"widgets" => [
{
"type" => "image",
"height" => 20,
"width" => 32,
"y" => 7,
"x" => 32,
"url" => "https://path/to/image.jpg"
}
]
}
result = dog.create_screenboard(board)
api_key=<DATADOG_API_KEY>
app_key=<DATADOG_APPLICATION_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"width": 1024,
"height": 768,
"board_title": "dogapi test",
"widgets": [
{
"type": "image",
"height": 20,
"width": 32,
"y": 7,
"x": 32,
"url": "https://path/to/image.jpg"
}
]
}' \
"https://api.datadoghq.com/api/v1/screen?api_key=${DD_CLIENT_API_KEY}&application_key=${DD_CLIENT_APP_KEY}"
Update a screenboard
Signature
PUT https://api.datadoghq.com/api/v1/screen/<SCREEENBOARD_ID>
Arguments
board_title [required]:
The name of the dashboard.description [optional, default=None]:
A description of the dashboard’s content.widgets [required]:
A list of widget definitions. To get a widget definition, use the JSON tab in the widget configuration UI.template_variables [optional, default=None]:
A list of template variables for using Dashboard templating.width [optional, default=None]:
Screenboard width in pixelsheight [optional, default=None]:
Screenboard height in pixels.read_only [optional, default=False]:
The read-only status of the screenboard.
Examples
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
board_id = 2551
board_title = "My Screenboard"
description = "An informative screenboard."
width = 1024
widgets = [{
"type": "image",
"height": 20,
"width": 32,
"y": 7,
"x": 32,
"url": "https://path/to/image.jpg"
}]
template_variables = [{
"name": "host1",
"prefix": "host",
"default": "host:my-host"
}]
api.Screenboard.update(board_id,
board_title=board_title,
description=description,
widgets=widgets,
template_variables=template_variables,
width=width)
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
board_id = 7953
board = {
"width" => 1024,
"height" => 768,
"board_title" => "dogapi test",
"widgets" => [{
"type" => "image",
"height" => 20,
"width" => 32,
"y" => 7,
"x" => 32,
"url" => "https://path/to/image.jpg"
}]
}
result = dog.update_screenboard(board_id, board)
api_key=<DATADOG_API_KEY>
app_key=<DATADOG_APPLICATION_KEY>
curl -X PUT -H "Content-type: application/json" \
-d '{
"width": 1024,
"height": 768,
"board_title": "dogapi test",
"widgets": [
{
"type": "image",
"height": 20,
"width": 32,
"y": 7,
"x": 32,
"url": "https://path/to/image.jpg"
}
]
}' \
"https://api.datadoghq.com/api/v1/screen/${board_id}?api_key=${DD_CLIENT_API_KEY}&application_key=${DD_CLIENT_APP_KEY}"
Delete a screenboard
Delete an existing screenboard.
This endpoint takes no JSON arguments.
Signature
DELETE https://api.datadoghq.com/api/v1/screen/<SCREEENBOARD_ID>
Arguments
This endpoint takes no JSON arguments.
Examples
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
api.Screenboard.delete(811)
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
board_id = '2534'
result = dog.delete_screenboard(board_id)
api_key=<DATADOG_API_KEY>
app_key=<DATADOG_APPLICATION_KEY>
board_id=2471
# Create a screenboard to delete
board_id=$(curl -X POST -H "Content-type: application/json" \
-d '{
"width": 1024,
"height": 768,
"board_title": "dogapi tests",
"widgets": [
{
"type": "image",
"height": 20,
"width": 32,
"y": 7,
"x": 32,
"url": "https://path/to/image.jpg"
}
]
}' \
"https://api.datadoghq.com/api/v1/screen?api_key=${DD_CLIENT_API_KEY}&application_key=${DD_CLIENT_APP_KEY}" | jq '.id')
curl -X DELETE \
"https://api.datadoghq.com/api/v1/screen/${board_id}?api_key=${DD_CLIENT_API_KEY}&application_key=${DD_CLIENT_APP_KEY}"
Get a screenboard
Fetch an existing screenboard definition.
Signature
GET https://api.datadoghq.com/api/v1/screen/<SCREEENBOARD_ID>
Arguments
This endpoint takes no JSON arguments.
Examples
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
api.Screenboard.get(811)
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
board_id = '6334'
result = dog.get_screenboard(board_id)
api_key=<DATADOG_API_KEY>
app_key=<DATADOG_APPLICATION_KEY>
board_id=6334
# Create a screenboard to get
board_id=$(curl -X POST -H "Content-type: application/json" \
-d '{
"width": 1024,
"height": 768,
"board_title": "dogapi tests",
"widgets": [
{
"type": "image",
"height": 20,
"width": 32,
"y": 7,
"x": 32,
"url": "https://path/to/image.jpg"
}
]
}' \
"https://api.datadoghq.com/api/v1/screen?api_key=${DD_CLIENT_API_KEY}&application_key=${DD_CLIENT_APP_KEY}" | jq '.id')
curl -X GET \
"https://api.datadoghq.com/api/v1/screen/${board_id}?api_key=${DD_CLIENT_API_KEY}&application_key=${DD_CLIENT_APP_KEY}"
Get all screenboards
Fetch all of your screenboards’ definitions.
Signature
GET https://api.datadoghq.com/api/v1/screen
Arguments
This endpoint takes no JSON arguments.
Examples
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
api.Screenboard.get_all()
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.get_all_screenboards()
api_key=<DATADOG_API_KEY>
app_key=<DATADOG_APPLICATION_KEY>
curl -X GET "https://api.datadoghq.com/api/v1/screen?api_key=${DD_CLIENT_API_KEY}&application_key=${DD_CLIENT_APP_KEY}"
