For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/app-builder/update-app-favorite-status.md. A documentation index is available at /llms.txt.
Language
Datadog site
CAUTIONThis product is not supported for your selected Datadog site. (US2-FED).

Update App Favorite Status

PATCHhttps://api.datadoghq.com/api/v2/app-builder/apps/{app_id}/favoritehttps://api.us3.datadoghq.com/api/v2/app-builder/apps/{app_id}/favoritehttps://api.us5.datadoghq.com/api/v2/app-builder/apps/{app_id}/favoritehttps://api.datadoghq.eu/api/v2/app-builder/apps/{app_id}/favoritehttps://api.ap1.datadoghq.com/api/v2/app-builder/apps/{app_id}/favoritehttps://api.ap2.datadoghq.com/api/v2/app-builder/apps/{app_id}/favoritehttps://api.uk1.datadoghq.com/api/v2/app-builder/apps/{app_id}/favoritehttps://api.ddog-gov.com/api/v2/app-builder/apps/{app_id}/favoritehttps://api.us2.ddog-gov.com/api/v2/app-builder/apps/{app_id}/favorite

Overview

Add or remove an app from the current user's favorites. Favorited apps can be filtered for using the filter[favorite] query parameter on the List Apps endpoint.

This endpoint requires the apps_run permission.

Arguments

Path Parameters

Name
Type
Description
app_id [required]
string

The ID of the app.

Request

Body Data (required)

Field
Type
Description
data
object

Data for updating an app's favorite status.

Response

No Content

Code Example

Update App Favorite Status returns "No Content" response
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF
# Path parameters
export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"

# 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 PATCH "https://api.${DD_SITE}/api/v2/app-builder/apps/${app_id}/favorite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "favorite": true
    },
    "type": "favorites"
  }
}
EOF