For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/annotations/create-an-annotation.md. A documentation index is available at /llms.txt.
Language
Datadog site

Create an annotation

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
POSThttps://api.datadoghq.com/api/v2/annotationhttps://api.us3.datadoghq.com/api/v2/annotationhttps://api.us5.datadoghq.com/api/v2/annotationhttps://api.datadoghq.eu/api/v2/annotationhttps://api.ap1.datadoghq.com/api/v2/annotationhttps://api.ap2.datadoghq.com/api/v2/annotationhttps://api.uk1.datadoghq.com/api/v2/annotationhttps://api.ddog-gov.com/api/v2/annotationhttps://api.us2.ddog-gov.com/api/v2/annotation

Overview

Creates a new annotation on a dashboard or notebook page. Valid color values: gray, blue, purple, green, yellow, red. Valid type values: pointInTime (marks a single moment) or timeRegion (spans a range and requires end_time).

Request

Body Data (required)

Annotation to create.

Field
Type
Description
data [required]
object

Data for creating an annotation.

Response

OK

Response containing a single annotation.

Field
Type
Description
data [required]
object

A single annotation resource.

Code Example

Create an annotation returns "OK" response
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/annotation" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}
EOF