--- title: App 나열하기 description: 선택적 필터 및 정렬을 사용하여 모든 앱을 나열합니다. 이 엔드포인트는 페이지 지정을 지원합니다. 이 엔드포인트는 앱 ID, 이름, 설명과 같은 기본 앱 정보만 반환합니다. 이 API에는 [등록된 애플리케이션 키]가… breadcrumbs: 문서 > API > App 나열하기 --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # App 나열하기 {% callout %} This product or feature is not supported for the following sites: us2.ddog-gov.com {% /callout %} ## v2 (latest) | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/app-builder/apps | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/app-builder/apps | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/app-builder/apps | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/app-builder/apps | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/app-builder/apps | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/app-builder/apps | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/app-builder/apps | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/app-builder/apps | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/app-builder/apps | ### Overview 선택적 필터 및 정렬을 사용하여 모든 앱을 나열합니다. 이 엔드포인트는 페이지 지정을 지원합니다. 이 엔드포인트는 앱 ID, 이름, 설명과 같은 기본 앱 정보만 반환합니다. 이 API에는 [등록된 애플리케이션 키]가 필요합니다([https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key](https://docs.datadoghq.com/api/latest/action-connection.md#register-a-new-app-key)). 또는 [UI에서] 이러한 권한을 구성할 수 있습니다([https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access](https://docs.datadoghq.com/account_management/api-app-keys.md#actions-api-access)). This endpoint requires the `apps_run` permission. ### Arguments #### Query Strings | Field | Type | Description | | -------------------- | ------- | ------------------------------------------------------------- | | limit | integer | The number of apps to return per page. | | page | integer | The page number to return. | | filter[user_name] | string | Filter apps by the app creator. Usually the user's email. | | filter[user_uuid] | string | Filter apps by the app creator's UUID. | | filter[name] | string | Filter by app name. | | filter[query] | string | Filter apps by the app name or the app creator. | | filter[deployed] | boolean | Filter apps by whether they are published. | | filter[tags] | string | Filter apps by tags. | | filter[favorite] | boolean | Filter apps by whether you have added them to your favorites. | | filter[self_service] | boolean | Filter apps by whether they are enabled for self-service. | | sort | array | The fields and direction to sort apps by. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} A paginated list of apps matching the specified filters and sorting. | Parent field | Field | Type | Description | | ------------- | ------------------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | An array of app definitions. | | data | attributes [*required*] | object | Basic information about the app such as name, description, and tags. | | attributes | description | string | A human-readable description for the app. | | attributes | favorite | boolean | Whether the app is marked as a favorite by the current user. | | attributes | name | string | The name of the app. | | attributes | selfService | boolean | Whether the app is enabled for use in the Datadog self-service hub. | | attributes | tags | [string] | A list of tags for the app, which can be used to filter apps. | | data | id [*required*] | uuid | The ID of the app. | | data | meta | object | Metadata of an app. | | meta | created_at | date-time | Timestamp of when the app was created. | | meta | deleted_at | date-time | Timestamp of when the app was deleted. | | meta | org_id | int64 | The Datadog organization ID that owns the app. | | meta | updated_at | date-time | Timestamp of when the app was last updated. | | meta | updated_since_deployment | boolean | Whether the app was updated since it was last published. Published apps are pinned to a specific version and do not automatically update when the app is updated. | | meta | user_id | int64 | The ID of the user who created the app. | | meta | user_name | string | The name (or email address) of the user who created the app. | | meta | user_uuid | uuid | The UUID of the user who created the app. | | meta | version | int64 | The version number of the app. This starts at 1 and increments with each update. | | data | relationships | object | The app's publication information. | | relationships | deployment | object | Information pointing to the app's publication status. | | deployment | data | object | Data object containing the deployment ID. | | data | id | uuid | The deployment ID. | | data | type | enum | The deployment type. Allowed enum values: `deployment`. Default: `deployment`. | | deployment | meta | object | Metadata object containing the publication creation information. | | meta | created_at | date-time | Timestamp of when the app was published. | | meta | user_id | int64 | The ID of the user who published the app. | | meta | user_name | string | The name (or email address) of the user who published the app. | | meta | user_uuid | uuid | The UUID of the user who published the app. | | data | type [*required*] | enum | The app definition type. Allowed enum values: `appDefinitions`. Default: `appDefinitions`. | | | included | [object] | Data on the version of the app that was published. | | included | attributes | object | The attributes object containing the version ID of the published app. | | attributes | app_version_id | uuid | The version ID of the app that was published. For an unpublished app, this is always the nil UUID (`00000000-0000-0000-0000-000000000000`). | | included | id | uuid | The deployment ID. | | included | meta | object | Metadata object containing the publication creation information. | | meta | created_at | date-time | Timestamp of when the app was published. | | meta | user_id | int64 | The ID of the user who published the app. | | meta | user_name | string | The name (or email address) of the user who published the app. | | meta | user_uuid | uuid | The UUID of the user who published the app. | | included | type | enum | The deployment type. Allowed enum values: `deployment`. Default: `deployment`. | | | meta | object | Pagination metadata. | | meta | page | object | Information on the total number of apps, to be used for pagination. | | page | totalCount | int64 | The total number of apps under the Datadog organization, disregarding any filters applied. | | page | totalFilteredCount | int64 | The total number of apps that match the specified filters. | {% /tab %} {% tab label="Example" %} ```json { "data": [ { "attributes": { "description": "string", "favorite": false, "name": "string", "selfService": false, "tags": [ "service:webshop-backend", "team:webshop" ] }, "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693", "meta": { "created_at": "2019-09-19T10:00:00.000Z", "deleted_at": "2019-09-19T10:00:00.000Z", "org_id": "integer", "updated_at": "2019-09-19T10:00:00.000Z", "updated_since_deployment": false, "user_id": "integer", "user_name": "string", "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693", "version": "integer" }, "relationships": { "deployment": { "data": { "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693", "type": "deployment" }, "meta": { "created_at": "2019-09-19T10:00:00.000Z", "user_id": "integer", "user_name": "string", "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693" } } }, "type": "appDefinitions" } ], "included": [ { "attributes": { "app_version_id": "65bb1f25-52e1-4510-9f8d-22d1516ed693" }, "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693", "meta": { "created_at": "2019-09-19T10:00:00.000Z", "user_id": "integer", "user_name": "string", "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693" }, "type": "deployment" } ], "meta": { "page": { "totalCount": "integer", "totalFilteredCount": "integer" } } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/app-builder/apps" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // List Apps returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewAppBuilderApi(apiClient) resp, r, err := api.ListApps(ctx, *datadogV2.NewListAppsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AppBuilderApi.ListApps`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `AppBuilderApi.ListApps`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // List Apps returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.AppBuilderApi; import com.datadog.api.client.v2.model.ListAppsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); AppBuilderApi apiInstance = new AppBuilderApi(defaultClient); try { ListAppsResponse result = apiInstance.listApps(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AppBuilderApi#listApps"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ List Apps returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.app_builder_api import AppBuilderApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = AppBuilderApi(api_client) response = api_instance.list_apps() print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # List Apps returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::AppBuilderAPI.new p api_instance.list_apps() ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // List Apps returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_app_builder::AppBuilderAPI; use datadog_api_client::datadogV2::api_app_builder::ListAppsOptionalParams; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = AppBuilderAPI::with_config(configuration); let resp = api.list_apps(ListAppsOptionalParams::default()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * List Apps returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.AppBuilderApi(configuration); apiInstance .listApps() .then((data: v2.ListAppsResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}