For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/service-checks/submit-a-service-check.md. A documentation index is available at /llms.txt.
Language
Datadog site

Submit a Service Check

POSThttps://api.datadoghq.com/api/v1/check_runhttps://api.us3.datadoghq.com/api/v1/check_runhttps://api.us5.datadoghq.com/api/v1/check_runhttps://api.datadoghq.eu/api/v1/check_runhttps://api.ap1.datadoghq.com/api/v1/check_runhttps://api.ap2.datadoghq.com/api/v1/check_runhttps://api.uk1.datadoghq.com/api/v1/check_runhttps://api.ddog-gov.com/api/v1/check_runhttps://api.us2.ddog-gov.com/api/v1/check_run

Overview

Submit a list of Service Checks.

Notes:

  • A valid API key is required.
  • Service checks can be submitted up to 10 minutes in the past.

Request

Body Data (required)

Service Check request body.

Field
Type
Description
check [required]
string

The check.

host_name [required]
string

The host name correlated with the check.

message
string

Message containing check status.

status [required]
enum

The status of a service check. Set to 0 for OK, 1 for warning, 2 for critical, and 3 for unknown.

Allowed enum values: 0, 1, 2, 3
tags [required]
[string]

Tags related to a check.

timestamp
int64

Time of check.

Response

Payload accepted

The payload accepted for intake.

Field
Type
Description
status
string

The status of the intake payload.

Code Example

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X POST "https://api.${DD_SITE}/api/v1/check_run" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "status": 0,
    "tags": [
      "environment:test"
    ]
  }
]
EOF