DELETE https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}/invitation https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}/invitation https://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitation https://api.ddog-gov.com/api/v1/dashboard/public/{token}/invitation https://api.us2.ddog-gov.com/api/v1/dashboard/public/{token}/invitation https://api.uk1.datadoghq.com/api/v1/dashboard/public/{token}/invitation https://api.datadoghq.com/api/v1/dashboard/public/{token}/invitation https://api.us3.datadoghq.com/api/v1/dashboard/public/{token}/invitation https://api.us5.datadoghq.com/api/v1/dashboard/public/{token}/invitation
Présentation Révoquez, pour des adresses e-mail précises, les e-mails d’invitation envoyés précédemment et les sessions actives utilisées afin d’accéder à un dashboard partagé donné.
This endpoint requires the dashboards_invite_share permission.
OAuth apps require the dashboards_invite_share authorization scope to access this endpoint.
Arguments Paramètres du chemin The token of the shared dashboard.
Requête Body Data (required) Corps de requête pour la suppression d’une invitation à consulter un dashboard partagé.
Expand All
An object or list of objects containing the information for an invitation to a shared dashboard.
Object containing the information for an invitation to a shared dashboard.
Attributes of the shared dashboard invitation
When the invitation was sent.
An email address that an invitation has been (or if used in invitation request, will be) sent to.
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
When the invitation expires.
When the invited user's session expires. null if the invitation has no associated session.
The unique token of the shared dashboard that was (or is to be) shared.
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
A list of objects containing the information for an invitation(s) to a shared dashboard.
Attributes of the shared dashboard invitation
When the invitation was sent.
An email address that an invitation has been (or if used in invitation request, will be) sent to.
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
When the invitation expires.
When the invited user's session expires. null if the invitation has no associated session.
The unique token of the shared dashboard that was (or is to be) shared.
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
Pagination metadata returned by the API.
Object containing the total count of invitations across all pages
The total number of invitations on this shared board, across all pages.
{
"data" : [
"undefined"
]
} Réponse Forbidden
Error response object.
Expand All
Array of errors returned by the API.
{
"errors" : [
"Bad Request"
]
} Not Found
Error response object.
Expand All
Array of errors returned by the API.
{
"errors" : [
"Bad Request"
]
} Too many requests
Error response object.
Expand All
Array of errors returned by the API.
{
"errors" : [
"Bad Request"
]
} Exemple de code Copier
## default
#
# Path parameters export token = "CHANGE_ME" # Curl command curl -X DELETE "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.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v1/dashboard/public/${token}/invitation " \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " \
-d @- << EOF
{
"data": {
"attributes": {
"email": "[email protected] "
},
"type": "public_dashboard_invitation"
}
}
EOF ## json-request-body
#
# Path parameters export token = "CHANGE_ME" # Curl command curl -X DELETE "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.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v1/dashboard/public/${token}/invitation " \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " \
-d @- << EOF
{
"data": {
"attributes": {
"email": "[email protected] "
},
"type": "public_dashboard_invitation"
}
}
EOF
"""
Revoke shared dashboard invitations returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_invite_type import DashboardInviteType
from datadog_api_client.v1.model.shared_dashboard_invites import SharedDashboardInvites
from datadog_api_client.v1.model.shared_dashboard_invites_data_list import SharedDashboardInvitesDataList
from datadog_api_client.v1.model.shared_dashboard_invites_data_object import SharedDashboardInvitesDataObject
from datadog_api_client.v1.model.shared_dashboard_invites_data_object_attributes import (
SharedDashboardInvitesDataObjectAttributes ,
)
body = SharedDashboardInvites (
data = SharedDashboardInvitesDataList (
[
SharedDashboardInvitesDataObject (
attributes = SharedDashboardInvitesDataObjectAttributes (
email = "[email protected] " ,
),
type = DashboardInviteType . PUBLIC_DASHBOARD_INVITATION ,
),
]
),
)
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = DashboardsApi ( api_client )
api_instance . delete_public_dashboard_invitation ( token = "token" , 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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Revoke shared dashboard invitations returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V1 :: DashboardsAPI . new
body = DatadogAPIClient :: V1 :: SharedDashboardInvites . new ({
data : [
DatadogAPIClient :: V1 :: SharedDashboardInvitesDataObject . new ({
attributes : DatadogAPIClient :: V1 :: SharedDashboardInvitesDataObjectAttributes . new ({
email : "[email protected] " ,
}),
type : DatadogAPIClient :: V1 :: DashboardInviteType :: PUBLIC_DASHBOARD_INVITATION ,
}),
] ,
})
api_instance . delete_public_dashboard_invitation ( "token" , 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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Revoke shared dashboard invitations returns "OK" 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/datadogV1"
)
func main () {
body := datadogV1 . SharedDashboardInvites {
Data : datadogV1 . SharedDashboardInvitesData {
SharedDashboardInvitesDataList : & [] datadogV1 . SharedDashboardInvitesDataObject {
{
Attributes : datadogV1 . SharedDashboardInvitesDataObjectAttributes {
Email : datadog . PtrString ( "[email protected] " ),
},
Type : datadogV1 . DASHBOARDINVITETYPE_PUBLIC_DASHBOARD_INVITATION ,
},
}},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV1 . NewDashboardsApi ( apiClient )
r , err := api . DeletePublicDashboardInvitation ( ctx , "token" , body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `DashboardsApi.DeletePublicDashboardInvitation`: %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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Revoke shared dashboard invitations returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v1.api.DashboardsApi ;
import com.datadog.api.client.v1.model.DashboardInviteType ;
import com.datadog.api.client.v1.model.SharedDashboardInvites ;
import com.datadog.api.client.v1.model.SharedDashboardInvitesData ;
import com.datadog.api.client.v1.model.SharedDashboardInvitesDataObject ;
import com.datadog.api.client.v1.model.SharedDashboardInvitesDataObjectAttributes ;
import java.util.Collections ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
DashboardsApi apiInstance = new DashboardsApi ( defaultClient );
SharedDashboardInvites body =
new SharedDashboardInvites ()
. data (
new SharedDashboardInvitesData (
Collections . singletonList (
new SharedDashboardInvitesDataObject ()
. attributes (
new SharedDashboardInvitesDataObjectAttributes ()
. email ( "[email protected] " ))
. type ( DashboardInviteType . PUBLIC_DASHBOARD_INVITATION ))));
try {
apiInstance . deletePublicDashboardInvitation ( "token" , body );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling DashboardsApi#deletePublicDashboardInvitation" );
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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Revoke shared dashboard invitations returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV1 ::api_dashboards ::DashboardsAPI ;
use datadog_api_client ::datadogV1 ::model ::DashboardInviteType ;
use datadog_api_client ::datadogV1 ::model ::SharedDashboardInvites ;
use datadog_api_client ::datadogV1 ::model ::SharedDashboardInvitesData ;
use datadog_api_client ::datadogV1 ::model ::SharedDashboardInvitesDataObject ;
use datadog_api_client ::datadogV1 ::model ::SharedDashboardInvitesDataObjectAttributes ;
#[tokio::main]
async fn main () {
let body =
SharedDashboardInvites ::new ( SharedDashboardInvitesData ::SharedDashboardInvitesDataList (
vec! [ SharedDashboardInvitesDataObject ::new (
SharedDashboardInvitesDataObjectAttributes ::new ()
. email ( "[email protected] " . to_string ()),
DashboardInviteType ::PUBLIC_DASHBOARD_INVITATION ,
)],
));
let configuration = datadog ::Configuration ::new ();
let api = DashboardsAPI ::with_config ( configuration );
let resp = api
. delete_public_dashboard_invitation ( "token" . to_string (), 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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Revoke shared dashboard invitations returns "OK" response
*/
import { client , v1 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v1 . DashboardsApi ( configuration );
const params : v1.DashboardsApiDeletePublicDashboardInvitationRequest = {
body : {
data : [
{
attributes : {
email : "[email protected] " ,
},
type : "public_dashboard_invitation" ,
},
],
},
token : "token" ,
};
apiInstance
. deletePublicDashboardInvitation ( 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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"