Mettre à jour une équipe
PATCH
https://api.datadoghq.com/api/v2/team/{team_id}https://api.us3.datadoghq.com/api/v2/team/{team_id}https://api.us5.datadoghq.com/api/v2/team/{team_id}https://api.datadoghq.eu/api/v2/team/{team_id}https://api.ap1.datadoghq.com/api/v2/team/{team_id}https://api.ap2.datadoghq.com/api/v2/team/{team_id}https://api.uk1.datadoghq.com/api/v2/team/{team_id}https://api.ddog-gov.com/api/v2/team/{team_id}https://api.us2.ddog-gov.com/api/v2/team/{team_id}Présentation
Mettez à jour une équipe en utilisant son id.
Si la relation team_links est présente, les liens associés sont mis à jour dans l'ordre où ils apparaissent dans le tableau, et tous les liens d'équipe existants qui ne sont pas présents sont supprimés.
OAuth apps require the teams_read authorization scope to access this endpoint.
Arguments
Paramètres du chemin
Name
Type
Description
team_id [required]string
None
Requête
Body Data (required)
Champ
Type
Description
data [required]object
Requête de mise à jour de l'équipe
attributes [required]object
Team update attributes
avatarstring
Unicode representation of the avatar for the team, limited to a single grapheme
bannerint64
Banner selection for the team
descriptionstring
Free-form markdown description/content for the team's homepage
handle [required]string
The team's identifier
hidden_modules[string]
Collection of hidden modules for the team
name [required]string
The name of the team
visible_modules[string]
Collection of visible modules for the team
relationshipsobject
Team update relationships
team_linksobject
Relationship between a team and a team link
data[object]
Related team links
id [required]string
The team link's identifier
type [required]enum
Team link type
team_linksAllowed enum values:
team_linkslinksobject
Links attributes.
relatedstring
Related link.
type [required]enum
Team type
teamAllowed enum values:
team{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}Réponse
OK
Response with a team
Champ
Type
Description
dataobject
A team
attributes [required]object
Team attributes
avatarstring
Unicode representation of the avatar for the team, limited to a single grapheme
bannerint64
Banner selection for the team
created_atdate-time
Creation date of the team
descriptionstring
Free-form markdown description/content for the team's homepage
handle [required]string
The team's identifier
handles[string]
Collection of handles associated with the team.
hidden_modules[string]
Collection of hidden modules for the team
is_managedboolean
Whether the team is managed from an external source
is_open_membershipboolean
Whether any user can join the team without an invitation.
link_countint32
The number of links belonging to the team
modified_atdate-time
Modification date of the team
name [required]string
The name of the team
provisioned_bystring
The mechanism that created the team, such as teams_api, teams_terraform, or teams_ui.
Omitted when unknown.
summarystring
A brief summary of the team, derived from the description
user_countint32
The number of users belonging to the team
visible_modules[string]
Collection of visible modules for the team
id [required]string
The team's identifier
relationshipsobject
Resources related to a team
team_linksobject
Relationship between a team and a team link
data[object]
Related team links
id [required]string
The team link's identifier
type [required]enum
Team link type
team_linksAllowed enum values:
team_linkslinksobject
Links attributes.
relatedstring
Related link.
user_team_permissionsobject
Relationship between a user team permission and a team
dataobject
Related user team permission data
id [required]string
The ID of the user team permission
type [required]enum
User team permission type
user_team_permissionsAllowed enum values:
user_team_permissionslinksobject
Links attributes.
relatedstring
Related link.
type [required]enum
Team type
teamAllowed enum values:
teamincluded[<oneOf>]
Resources related to the team.
<type=users>object
User object returned by the API.
attributesobject
Attributes of user object returned by the API.
created_atdate-time
The ISO 8601 timestamp of when the user account was created.
disabledboolean
Whether the user account is deactivated. Disabled users cannot log in.
emailstring
The email address of the user, used for login and notifications.
handlestring
The unique handle (username) of the user, typically matching their email prefix.
iconstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_timedate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabledboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_atdate-time
The ISO 8601 timestamp of when the user account was last modified.
namestring
The full display name of the user as shown in the Datadog UI.
service_accountboolean
Whether this is a service account rather than a human user. Service accounts are used for programmatic API access.
statusstring
The current status of the user account (for example, Active, Pending, or Disabled).
titlestring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuidstring
The globally unique identifier (UUID) of the user.
verifiedboolean
Whether the user's email address has been verified.
idstring
ID of the user.
relationshipsobject
Relationships of the user object returned by the API.
orgobject
Relationship to an organization.
data [required]object
Relationship to organization object.
id [required]string
ID of the organization.
type [required]enum
Organizations resource type.
orgsAllowed enum values:
orgsother_orgsobject
Relationship to organizations.
data [required][object]
Relationships to organization objects.
id [required]string
ID of the organization.
type [required]enum
Organizations resource type.
orgsAllowed enum values:
orgsother_usersobject
Relationship to users.
data [required][object]
Relationships to user objects.
id [required]string
A unique identifier that represents the user.
type [required]enum
Users resource type.
usersAllowed enum values:
usersrolesobject
Relationship to roles.
data[object]
An array containing type and the unique identifier of a role.
idstring
The unique identifier of the role.
typeenum
Roles type.
rolesAllowed enum values:
rolestypeenum
Users resource type.
usersAllowed enum values:
users<type=team_links>object
Team link
attributes [required]object
Team link attributes
label [required]string
The link's label
positionint32
The link's position, used to sort links for the team
team_idstring
ID of the team the link is associated with
url [required]string
The URL for the link
id [required]string
The team link's identifier
type [required]enum
Team link type
team_linksAllowed enum values:
team_links<type=user_team_permissions>object
A user's permissions for a given team
attributesobject
User team permission attributes
permissionsobject
Object of team permission actions and boolean values that a logged in user can perform on this team.
id [required]string
The user team permission's identifier
type [required]enum
User team permission type
user_team_permissionsAllowed enum values:
user_team_permissions{
"data": {
"attributes": {
"avatar": "🥑",
"banner": "integer",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"handle": "example-team",
"handles": [],
"hidden_modules": [],
"is_managed": false,
"is_open_membership": false,
"link_count": "integer",
"modified_at": "2019-09-19T10:00:00.000Z",
"name": "Example Team",
"provisioned_by": "teams_api",
"summary": "string",
"user_count": "integer",
"visible_modules": []
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001",
"type": "team_links"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
},
"user_team_permissions": {
"data": {
"id": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595",
"type": "user_team_permissions"
},
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
},
"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"
}
]
}API error response.
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Forbidden
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}API error response.
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}API error response.
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Exemple de code
# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOF# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOF# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOF# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOF# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOF# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOF# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOF# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOF# Path parameters
export team_id="CHANGE_ME"
# 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/team/${team_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"avatar": "🥑",
"handle": "example-team",
"name": "Example Team"
},
"relationships": {
"team_links": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
}
},
"type": "team"
}
}
EOFUpdate a team returns "OK" response
// Update a team 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 "dd_team" in the system
DdTeamDataAttributesHandle := os.Getenv("DD_TEAM_DATA_ATTRIBUTES_HANDLE")
DdTeamDataID := os.Getenv("DD_TEAM_DATA_ID")
body := datadogV2.TeamUpdateRequest{
Data: datadogV2.TeamUpdate{
Attributes: datadogV2.TeamUpdateAttributes{
Handle: DdTeamDataAttributesHandle,
Name: "Example Team updated",
Avatar: *datadog.NewNullableString(datadog.PtrString("🥑")),
Banner: *datadog.NewNullableInt64(datadog.PtrInt64(7)),
HiddenModules: []string{
"m3",
},
VisibleModules: []string{
"m1",
"m2",
},
},
Type: datadogV2.TEAMTYPE_TEAM,
},
}
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.NewTeamsApi(apiClient)
resp, r, err := api.UpdateTeam(ctx, DdTeamDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.UpdateTeam`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.UpdateTeam`:\n%s\n", responseContent)
}
Update a team with partial update returns "OK" response
// Update a team with partial update 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 "dd_team" in the system
DdTeamDataAttributesHandle := os.Getenv("DD_TEAM_DATA_ATTRIBUTES_HANDLE")
DdTeamDataID := os.Getenv("DD_TEAM_DATA_ID")
body := datadogV2.TeamUpdateRequest{
Data: datadogV2.TeamUpdate{
Attributes: datadogV2.TeamUpdateAttributes{
Handle: DdTeamDataAttributesHandle,
Name: "Example Team updated",
},
Type: datadogV2.TEAMTYPE_TEAM,
},
}
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.NewTeamsApi(apiClient)
resp, r, err := api.UpdateTeam(ctx, DdTeamDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.UpdateTeam`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `TeamsApi.UpdateTeam`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Update a team returns "OK" response
// Update a team returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.TeamsApi;
import com.datadog.api.client.v2.model.TeamResponse;
import com.datadog.api.client.v2.model.TeamType;
import com.datadog.api.client.v2.model.TeamUpdate;
import com.datadog.api.client.v2.model.TeamUpdateAttributes;
import com.datadog.api.client.v2.model.TeamUpdateRequest;
import java.util.Arrays;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
TeamsApi apiInstance = new TeamsApi(defaultClient);
// there is a valid "dd_team" in the system
String DD_TEAM_DATA_ATTRIBUTES_HANDLE = System.getenv("DD_TEAM_DATA_ATTRIBUTES_HANDLE");
String DD_TEAM_DATA_ATTRIBUTES_NAME = System.getenv("DD_TEAM_DATA_ATTRIBUTES_NAME");
String DD_TEAM_DATA_ID = System.getenv("DD_TEAM_DATA_ID");
TeamUpdateRequest body =
new TeamUpdateRequest()
.data(
new TeamUpdate()
.attributes(
new TeamUpdateAttributes()
.handle(DD_TEAM_DATA_ATTRIBUTES_HANDLE)
.name("Example Team updated")
.avatar("🥑")
.banner(7L)
.hiddenModules(Collections.singletonList("m3"))
.visibleModules(Arrays.asList("m1", "m2")))
.type(TeamType.TEAM));
try {
TeamResponse result = apiInstance.updateTeam(DD_TEAM_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TeamsApi#updateTeam");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Update a team with partial update returns "OK" response
// Update a team with partial update returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.TeamsApi;
import com.datadog.api.client.v2.model.TeamResponse;
import com.datadog.api.client.v2.model.TeamType;
import com.datadog.api.client.v2.model.TeamUpdate;
import com.datadog.api.client.v2.model.TeamUpdateAttributes;
import com.datadog.api.client.v2.model.TeamUpdateRequest;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
TeamsApi apiInstance = new TeamsApi(defaultClient);
// there is a valid "dd_team" in the system
String DD_TEAM_DATA_ATTRIBUTES_HANDLE = System.getenv("DD_TEAM_DATA_ATTRIBUTES_HANDLE");
String DD_TEAM_DATA_ATTRIBUTES_NAME = System.getenv("DD_TEAM_DATA_ATTRIBUTES_NAME");
String DD_TEAM_DATA_ID = System.getenv("DD_TEAM_DATA_ID");
TeamUpdateRequest body =
new TeamUpdateRequest()
.data(
new TeamUpdate()
.attributes(
new TeamUpdateAttributes()
.handle(DD_TEAM_DATA_ATTRIBUTES_HANDLE)
.name("Example Team updated"))
.type(TeamType.TEAM));
try {
TeamResponse result = apiInstance.updateTeam(DD_TEAM_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TeamsApi#updateTeam");
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Update a team returns "OK" response
"""
Update a team returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.teams_api import TeamsApi
from datadog_api_client.v2.model.team_type import TeamType
from datadog_api_client.v2.model.team_update import TeamUpdate
from datadog_api_client.v2.model.team_update_attributes import TeamUpdateAttributes
from datadog_api_client.v2.model.team_update_request import TeamUpdateRequest
# there is a valid "dd_team" in the system
DD_TEAM_DATA_ATTRIBUTES_HANDLE = environ["DD_TEAM_DATA_ATTRIBUTES_HANDLE"]
DD_TEAM_DATA_ATTRIBUTES_NAME = environ["DD_TEAM_DATA_ATTRIBUTES_NAME"]
DD_TEAM_DATA_ID = environ["DD_TEAM_DATA_ID"]
body = TeamUpdateRequest(
data=TeamUpdate(
attributes=TeamUpdateAttributes(
handle=DD_TEAM_DATA_ATTRIBUTES_HANDLE,
name="Example Team updated",
avatar="🥑",
banner=7,
hidden_modules=[
"m3",
],
visible_modules=[
"m1",
"m2",
],
),
type=TeamType.TEAM,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = TeamsApi(api_client)
response = api_instance.update_team(team_id=DD_TEAM_DATA_ID, body=body)
print(response)
Update a team with partial update returns "OK" response
"""
Update a team with partial update returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.teams_api import TeamsApi
from datadog_api_client.v2.model.team_type import TeamType
from datadog_api_client.v2.model.team_update import TeamUpdate
from datadog_api_client.v2.model.team_update_attributes import TeamUpdateAttributes
from datadog_api_client.v2.model.team_update_request import TeamUpdateRequest
# there is a valid "dd_team" in the system
DD_TEAM_DATA_ATTRIBUTES_HANDLE = environ["DD_TEAM_DATA_ATTRIBUTES_HANDLE"]
DD_TEAM_DATA_ATTRIBUTES_NAME = environ["DD_TEAM_DATA_ATTRIBUTES_NAME"]
DD_TEAM_DATA_ID = environ["DD_TEAM_DATA_ID"]
body = TeamUpdateRequest(
data=TeamUpdate(
attributes=TeamUpdateAttributes(
handle=DD_TEAM_DATA_ATTRIBUTES_HANDLE,
name="Example Team updated",
),
type=TeamType.TEAM,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = TeamsApi(api_client)
response = api_instance.update_team(team_id=DD_TEAM_DATA_ID, body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Update a team returns "OK" response
# Update a team returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::TeamsAPI.new
# there is a valid "dd_team" in the system
DD_TEAM_DATA_ATTRIBUTES_HANDLE = ENV["DD_TEAM_DATA_ATTRIBUTES_HANDLE"]
DD_TEAM_DATA_ATTRIBUTES_NAME = ENV["DD_TEAM_DATA_ATTRIBUTES_NAME"]
DD_TEAM_DATA_ID = ENV["DD_TEAM_DATA_ID"]
body = DatadogAPIClient::V2::TeamUpdateRequest.new({
data: DatadogAPIClient::V2::TeamUpdate.new({
attributes: DatadogAPIClient::V2::TeamUpdateAttributes.new({
handle: DD_TEAM_DATA_ATTRIBUTES_HANDLE,
name: "Example Team updated",
avatar: "🥑",
banner: 7,
hidden_modules: [
"m3",
],
visible_modules: [
"m1",
"m2",
],
}),
type: DatadogAPIClient::V2::TeamType::TEAM,
}),
})
p api_instance.update_team(DD_TEAM_DATA_ID, body)
Update a team with partial update returns "OK" response
# Update a team with partial update returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::TeamsAPI.new
# there is a valid "dd_team" in the system
DD_TEAM_DATA_ATTRIBUTES_HANDLE = ENV["DD_TEAM_DATA_ATTRIBUTES_HANDLE"]
DD_TEAM_DATA_ATTRIBUTES_NAME = ENV["DD_TEAM_DATA_ATTRIBUTES_NAME"]
DD_TEAM_DATA_ID = ENV["DD_TEAM_DATA_ID"]
body = DatadogAPIClient::V2::TeamUpdateRequest.new({
data: DatadogAPIClient::V2::TeamUpdate.new({
attributes: DatadogAPIClient::V2::TeamUpdateAttributes.new({
handle: DD_TEAM_DATA_ATTRIBUTES_HANDLE,
name: "Example Team updated",
}),
type: DatadogAPIClient::V2::TeamType::TEAM,
}),
})
p api_instance.update_team(DD_TEAM_DATA_ID, 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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Update a team returns "OK" response
// Update a team returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_teams::TeamsAPI;
use datadog_api_client::datadogV2::model::TeamType;
use datadog_api_client::datadogV2::model::TeamUpdate;
use datadog_api_client::datadogV2::model::TeamUpdateAttributes;
use datadog_api_client::datadogV2::model::TeamUpdateRequest;
#[tokio::main]
async fn main() {
// there is a valid "dd_team" in the system
let dd_team_data_attributes_handle = std::env::var("DD_TEAM_DATA_ATTRIBUTES_HANDLE").unwrap();
let dd_team_data_id = std::env::var("DD_TEAM_DATA_ID").unwrap();
let body = TeamUpdateRequest::new(TeamUpdate::new(
TeamUpdateAttributes::new(
dd_team_data_attributes_handle.clone(),
"Example Team updated".to_string(),
)
.avatar(Some("🥑".to_string()))
.banner(Some(7))
.hidden_modules(vec!["m3".to_string()])
.visible_modules(vec!["m1".to_string(), "m2".to_string()]),
TeamType::TEAM,
));
let configuration = datadog::Configuration::new();
let api = TeamsAPI::with_config(configuration);
let resp = api.update_team(dd_team_data_id.clone(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Update a team with partial update returns "OK" response
// Update a team with partial update returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_teams::TeamsAPI;
use datadog_api_client::datadogV2::model::TeamType;
use datadog_api_client::datadogV2::model::TeamUpdate;
use datadog_api_client::datadogV2::model::TeamUpdateAttributes;
use datadog_api_client::datadogV2::model::TeamUpdateRequest;
#[tokio::main]
async fn main() {
// there is a valid "dd_team" in the system
let dd_team_data_attributes_handle = std::env::var("DD_TEAM_DATA_ATTRIBUTES_HANDLE").unwrap();
let dd_team_data_id = std::env::var("DD_TEAM_DATA_ID").unwrap();
let body = TeamUpdateRequest::new(TeamUpdate::new(
TeamUpdateAttributes::new(
dd_team_data_attributes_handle.clone(),
"Example Team updated".to_string(),
),
TeamType::TEAM,
));
let configuration = datadog::Configuration::new();
let api = TeamsAPI::with_config(configuration);
let resp = api.update_team(dd_team_data_id.clone(), 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" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runUpdate a team returns "OK" response
/**
* Update a team 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.TeamsApi(configuration);
// there is a valid "dd_team" in the system
const DD_TEAM_DATA_ATTRIBUTES_HANDLE = process.env
.DD_TEAM_DATA_ATTRIBUTES_HANDLE as string;
const DD_TEAM_DATA_ID = process.env.DD_TEAM_DATA_ID as string;
const params: v2.TeamsApiUpdateTeamRequest = {
body: {
data: {
attributes: {
handle: DD_TEAM_DATA_ATTRIBUTES_HANDLE,
name: "Example Team updated",
avatar: "🥑",
banner: 7,
hiddenModules: ["m3"],
visibleModules: ["m1", "m2"],
},
type: "team",
},
},
teamId: DD_TEAM_DATA_ID,
};
apiInstance
.updateTeam(params)
.then((data: v2.TeamResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Update a team with partial update returns "OK" response
/**
* Update a team with partial update 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.TeamsApi(configuration);
// there is a valid "dd_team" in the system
const DD_TEAM_DATA_ATTRIBUTES_HANDLE = process.env
.DD_TEAM_DATA_ATTRIBUTES_HANDLE as string;
const DD_TEAM_DATA_ID = process.env.DD_TEAM_DATA_ID as string;
const params: v2.TeamsApiUpdateTeamRequest = {
body: {
data: {
attributes: {
handle: DD_TEAM_DATA_ATTRIBUTES_HANDLE,
name: "Example Team updated",
},
type: "team",
},
},
teamId: DD_TEAM_DATA_ID,
};
apiInstance
.updateTeam(params)
.then((data: v2.TeamResponse) => {
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"