--- title: Get a Powerpack description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Powerpack --- # Get a Powerpack{% #get-a-powerpack %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------ | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/powerpacks/{powerpack_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/powerpacks/{powerpack_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/powerpacks/{powerpack_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/powerpacks/{powerpack_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/powerpacks/{powerpack_id} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/powerpacks/{powerpack_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/powerpacks/{powerpack_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/powerpacks/{powerpack_id} | ### Overview Get a powerpack. This endpoint requires the `dashboards_read` permission. OAuth apps require the `dashboards_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#powerpack) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------ | ------ | -------------------- | | powerpack_id [*required*] | string | ID of the powerpack. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response object which includes a single powerpack configuration. | Parent field | Field | Type | Description | | ------------------ | ------------------------------ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | Powerpack data object. | | data | attributes | object | Powerpack attribute object. | | attributes | description | string | Description of this powerpack. | | attributes | group_widget [*required*] | object | Powerpack group widget definition object. | | group_widget | definition [*required*] | object | Powerpack group widget object. | | definition | layout_type [*required*] | string | Layout type of widgets. | | definition | show_title | boolean | Boolean indicating whether powerpack group title should be visible or not. | | definition | title | string | Name for the group widget. | | definition | type [*required*] | string | Type of widget, must be group. | | definition | widgets [*required*] | [object] | Widgets inside the powerpack. | | widgets | definition [*required*] | object | Information about widget. | | widgets | layout | object | Powerpack inner widget layout. | | layout | height [*required*] | int64 | The height of the widget. Should be a non-negative integer. | | layout | width [*required*] | int64 | The width of the widget. Should be a non-negative integer. | | layout | x [*required*] | int64 | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | layout | y [*required*] | int64 | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | | group_widget | layout | object | Powerpack group widget layout. | | layout | height [*required*] | int64 | The height of the widget. Should be a non-negative integer. | | layout | width [*required*] | int64 | The width of the widget. Should be a non-negative integer. | | layout | x [*required*] | int64 | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | layout | y [*required*] | int64 | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | | group_widget | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | attributes | name [*required*] | string | Name of the powerpack. | | attributes | tags | [string] | List of tags to identify this powerpack. | | attributes | template_variables | [object] | List of template variables for this powerpack. | | template_variables | available_values | [string] | The list of values that the template variable drop-down is limited to. | | template_variables | defaults | [string] | One or many template variable default values within the saved view, which are unioned together using `OR` if more than one is specified. | | template_variables | name [*required*] | string | The name of the variable. | | template_variables | prefix | string | The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. | | data | id | string | ID of the powerpack. | | data | relationships | object | Powerpack relationship object. | | relationships | author | object | Relationship to user. | | author | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users` | | data | type | string | Type of widget, must be powerpack. | | | included | [object] | Array of objects related to the users. | | included | attributes | object | Attributes of user object returned by the API. | | attributes | created_at | date-time | The ISO 8601 timestamp of when the user account was created. | | attributes | disabled | boolean | Whether the user account is deactivated. Disabled users cannot log in. | | attributes | email | string | The email address of the user, used for login and notifications. | | attributes | handle | string | The unique handle (username) of the user, typically matching their email prefix. | | attributes | icon | string | URL of the user's profile icon, typically a Gravatar URL derived from the email address. | | attributes | last_login_time | date-time | The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in. | | attributes | mfa_enabled | boolean | Whether multi-factor authentication (MFA) is enabled for the user's account. | | attributes | modified_at | date-time | The ISO 8601 timestamp of when the user account was last modified. | | attributes | name | string | The full display name of the user as shown in the Datadog UI. | | attributes | service_account | boolean | Whether this is a service account rather than a human user. Service accounts are used for programmatic API access. | | attributes | status | string | The current status of the user account (for example, `Active`, `Pending`, or `Disabled`). | | attributes | title | string | The job title of the user (for example, "Senior Engineer" or "Product Manager"). | | attributes | uuid | string | The globally unique identifier (UUID) of the user. | | attributes | verified | boolean | Whether the user's email address has been verified. | | included | id | string | ID of the user. | | included | relationships | object | Relationships of the user object returned by the API. | | relationships | org | object | Relationship to an organization. | | org | data [*required*] | object | Relationship to organization object. | | data | id [*required*] | string | ID of the organization. | | data | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs` | | relationships | other_orgs | object | Relationship to organizations. | | other_orgs | data [*required*] | [object] | Relationships to organization objects. | | data | id [*required*] | string | ID of the organization. | | data | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs` | | relationships | other_users | object | Relationship to users. | | other_users | data [*required*] | [object] | Relationships to user objects. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users` | | relationships | roles | object | Relationship to roles. | | roles | data | [object] | An array containing type and the unique identifier of a role. | | data | id | string | The unique identifier of the role. | | data | type | enum | Roles type. Allowed enum values: `roles` | | included | type | enum | Users resource type. Allowed enum values: `users` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "description": "Powerpack for ABC", "group_widget": { "definition": { "layout_type": "ordered", "show_title": true, "title": "Sample Powerpack", "type": "group", "widgets": [ { "definition": { "definition": { "content": "example", "type": "note" } }, "layout": { "height": 0, "width": 0, "x": 0, "y": 0 } } ] }, "layout": { "height": 0, "width": 0, "x": 0, "y": 0 }, "live_span": "5m" }, "name": "Sample Powerpack", "tags": [ "tag:foo1" ], "template_variables": [ { "available_values": [ "my-host", "host1", "host2" ], "defaults": [ "*" ], "name": "datacenter", "prefix": "host" } ] }, "id": "string", "relationships": { "author": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } } }, "type": "powerpack" }, "included": [ { "attributes": { "created_at": "2019-09-19T10:00:00.000Z", "disabled": false, "email": "string", "handle": "string", "icon": "string", "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", "service_account": false, "status": "string", "title": "string", "uuid": "string", "verified": false }, "id": "string", "relationships": { "org": { "data": { "id": "00000000-0000-beef-0000-000000000000", "type": "orgs" } }, "other_orgs": { "data": [ { "id": "00000000-0000-beef-0000-000000000000", "type": "orgs" } ] }, "other_users": { "data": [ { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } ] }, "roles": { "data": [ { "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "roles" } ] } }, "type": "users" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Powerpack Not Found. {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export powerpack_id="CHANGE_ME" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/powerpacks/${powerpack_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get a Powerpack returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.powerpack_api import PowerpackApi # there is a valid "powerpack" in the system POWERPACK_DATA_ID = environ["POWERPACK_DATA_ID"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = PowerpackApi(api_client) response = api_instance.get_powerpack( powerpack_id=POWERPACK_DATA_ID, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get a Powerpack returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::PowerpackAPI.new # there is a valid "powerpack" in the system POWERPACK_DATA_ID = ENV["POWERPACK_DATA_ID"] p api_instance.get_powerpack(POWERPACK_DATA_ID) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get a Powerpack 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() { // there is a valid "powerpack" in the system PowerpackDataID := os.Getenv("POWERPACK_DATA_ID") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewPowerpackApi(apiClient) resp, r, err := api.GetPowerpack(ctx, PowerpackDataID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `PowerpackApi.GetPowerpack`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `PowerpackApi.GetPowerpack`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get a Powerpack returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.PowerpackApi; import com.datadog.api.client.v2.model.PowerpackResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); PowerpackApi apiInstance = new PowerpackApi(defaultClient); // there is a valid "powerpack" in the system String POWERPACK_DATA_ID = System.getenv("POWERPACK_DATA_ID"); try { PowerpackResponse result = apiInstance.getPowerpack(POWERPACK_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PowerpackApi#getPowerpack"); 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://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get a Powerpack returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_powerpack::PowerpackAPI; #[tokio::main] async fn main() { // there is a valid "powerpack" in the system let powerpack_data_id = std::env::var("POWERPACK_DATA_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = PowerpackAPI::with_config(configuration); let resp = api.get_powerpack(powerpack_data_id.clone()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get a Powerpack returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.PowerpackApi(configuration); // there is a valid "powerpack" in the system const POWERPACK_DATA_ID = process.env.POWERPACK_DATA_ID as string; const params: v2.PowerpackApiGetPowerpackRequest = { powerpackId: POWERPACK_DATA_ID, }; apiInstance .getPowerpack(params) .then((data: v2.PowerpackResponse) => { 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://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}