PATCH https://api.ap1.datadoghq.com/api/v2/app-builder/apps/{app_id}/self-service https://api.ap2.datadoghq.com/api/v2/app-builder/apps/{app_id}/self-service https://api.datadoghq.eu/api/v2/app-builder/apps/{app_id}/self-service https://api.ddog-gov.com/api/v2/app-builder/apps/{app_id}/self-service https://api.us2.ddog-gov.com/api/v2/app-builder/apps/{app_id}/self-service https://api.datadoghq.com/api/v2/app-builder/apps/{app_id}/self-service https://api.us3.datadoghq.com/api/v2/app-builder/apps/{app_id}/self-service https://api.us5.datadoghq.com/api/v2/app-builder/apps/{app_id}/self-service
Overview Enable or disable self-service for an app. Self-service apps can be discovered and run by users in your organization without explicit access being granted.
This endpoint requires the apps_write permission.
Arguments Path Parameters Request Body Data (required)
Expand All
Data for updating an app's self-service status.
Attributes for updating an app's self-service status.
Whether the app is enabled for self-service.
The self-service resource type.
Allowed enum values: selfService
default: selfService
{
"data" : {
"attributes" : {
"selfService" : true
},
"type" : "selfService"
}
} Response Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Forbidden
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Not Found
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
## default
#
# Path parameters export app_id = "65bb1f25-52e1-4510-9f8d-22d1516ed693" # Curl command curl -X PATCH "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/app-builder/apps/${app_id}/self-service " \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " \
-d @- << EOF
{
"data": {
"attributes": {
"selfService": true
},
"type": "selfService"
}
}
EOF
// Update App Self-Service Status returns "No Content" response
package main
import (
"context"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
"github.com/google/uuid"
)
func main () {
body := datadogV2 . UpdateAppSelfServiceRequest {
Data : & datadogV2 . UpdateAppSelfServiceRequestData {
Attributes : & datadogV2 . UpdateAppSelfServiceRequestDataAttributes {
SelfService : true ,
},
Type : datadogV2 . APPSELFSERVICETYPE_SELFSERVICE . Ptr (),
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewAppBuilderApi ( apiClient )
r , err := api . UpdateAppSelfService ( ctx , uuid . MustParse ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ), body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `AppBuilderApi.UpdateAppSelfService`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" go run "main.go"
// Update App Self-Service Status returns "No Content" 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.AppSelfServiceType ;
import com.datadog.api.client.v2.model.UpdateAppSelfServiceRequest ;
import com.datadog.api.client.v2.model.UpdateAppSelfServiceRequestData ;
import com.datadog.api.client.v2.model.UpdateAppSelfServiceRequestDataAttributes ;
import java.util.UUID ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
AppBuilderApi apiInstance = new AppBuilderApi ( defaultClient );
UpdateAppSelfServiceRequest body =
new UpdateAppSelfServiceRequest ()
. data (
new UpdateAppSelfServiceRequestData ()
. attributes ( new UpdateAppSelfServiceRequestDataAttributes (). selfService ( true ))
. type ( AppSelfServiceType . SELFSERVICE ));
try {
apiInstance . updateAppSelfService (
UUID . fromString ( "65bb1f25-52e1-4510-9f8d-22d1516ed693" ), body );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling AppBuilderApi#updateAppSelfService" );
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 and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" java "Example.java"
"""
Update App Self-Service Status returns "No Content" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.app_builder_api import AppBuilderApi
from datadog_api_client.v2.model.app_self_service_type import AppSelfServiceType
from datadog_api_client.v2.model.update_app_self_service_request import UpdateAppSelfServiceRequest
from datadog_api_client.v2.model.update_app_self_service_request_data import UpdateAppSelfServiceRequestData
from datadog_api_client.v2.model.update_app_self_service_request_data_attributes import (
UpdateAppSelfServiceRequestDataAttributes ,
)
from uuid import UUID
body = UpdateAppSelfServiceRequest (
data = UpdateAppSelfServiceRequestData (
attributes = UpdateAppSelfServiceRequestDataAttributes (
self_service = True ,
),
type = AppSelfServiceType . SELFSERVICE ,
),
)
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = AppBuilderApi ( api_client )
api_instance . update_app_self_service ( app_id = UUID ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ), body = body )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" python3 "example.py"
# Update App Self-Service Status returns "No Content" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: AppBuilderAPI . new
body = DatadogAPIClient :: V2 :: UpdateAppSelfServiceRequest . new ({
data : DatadogAPIClient :: V2 :: UpdateAppSelfServiceRequestData . new ({
attributes : DatadogAPIClient :: V2 :: UpdateAppSelfServiceRequestDataAttributes . new ({
self_service : true ,
}),
type : DatadogAPIClient :: V2 :: AppSelfServiceType :: SELFSERVICE ,
}),
})
api_instance . update_app_self_service ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" , body )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" rb "example.rb"
// Update App Self-Service Status returns "No Content" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_app_builder ::AppBuilderAPI ;
use datadog_api_client ::datadogV2 ::model ::AppSelfServiceType ;
use datadog_api_client ::datadogV2 ::model ::UpdateAppSelfServiceRequest ;
use datadog_api_client ::datadogV2 ::model ::UpdateAppSelfServiceRequestData ;
use datadog_api_client ::datadogV2 ::model ::UpdateAppSelfServiceRequestDataAttributes ;
use uuid ::Uuid ;
#[tokio::main]
async fn main () {
let body = UpdateAppSelfServiceRequest ::new (). data (
UpdateAppSelfServiceRequestData ::new ()
. attributes ( UpdateAppSelfServiceRequestDataAttributes ::new ( true ))
. type_ ( AppSelfServiceType ::SELFSERVICE ),
);
let configuration = datadog ::Configuration ::new ();
let api = AppBuilderAPI ::with_config ( configuration );
let resp = api
. update_app_self_service (
Uuid ::parse_str ( "00000000-0000-0000-0000-000000000000" ). expect ( "invalid UUID" ),
body ,
)
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" cargo run
/**
* Update App Self-Service Status returns "No Content" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . AppBuilderApi ( configuration );
const params : v2.AppBuilderApiUpdateAppSelfServiceRequest = {
body : {
data : {
attributes : {
selfService : true ,
},
type : "selfService" ,
},
},
appId : "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ,
};
apiInstance
. updateAppSelfService ( params )
. then (( data : any ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" tsc "example.ts"