Create a team

POST https://api.ap1.datadoghq.com/api/v2/teamhttps://api.ap2.datadoghq.com/api/v2/teamhttps://api.datadoghq.eu/api/v2/teamhttps://api.ddog-gov.com/api/v2/teamhttps://api.us2.ddog-gov.com/api/v2/teamhttps://api.datadoghq.com/api/v2/teamhttps://api.us3.datadoghq.com/api/v2/teamhttps://api.us5.datadoghq.com/api/v2/team

Overview

Create a new team. User IDs passed through the users relationship field are added to the team. This endpoint requires all of the following permissions:

  • teams_read
  • teams_manage

  • OAuth apps require the teams_read, teams_manage authorization scope to access this endpoint.

    Request

    Body Data (required)

    Expand All

    Field

    Type

    Description

    data [required]

    object

    Team create

    attributes [required]

    object

    Team creation attributes

    avatar

    string

    Unicode representation of the avatar for the team, limited to a single grapheme

    banner

    int64

    Banner selection for the team

    description

    string

    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

    relationships

    object

    Relationships formed with the team on creation

    users

    object

    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. Allowed enum values: users

    default: users

    type [required]

    enum

    Team type Allowed enum values: team

    default: team

    {
      "data": {
        "attributes": {
          "handle": "test-handle-a0fc0297eb519635",
          "name": "test-name-a0fc0297eb519635"
        },
        "relationships": {
          "users": {
            "data": []
          }
        },
        "type": "team"
      }
    }
    {
      "data": {
        "attributes": {
          "handle": "test-handle-a0fc0297eb519635",
          "name": "test-name-a0fc0297eb519635",
          "avatar": "\ud83e\udd51",
          "banner": 7,
          "visible_modules": [
            "m1",
            "m2"
          ],
          "hidden_modules": [
            "m3"
          ]
        },
        "type": "team"
      }
    }

    Response

    CREATED

    Response with a team

    Expand All

    Field

    Type

    Description

    data

    object

    A team

    attributes [required]

    object

    Team attributes

    avatar

    string

    Unicode representation of the avatar for the team, limited to a single grapheme

    banner

    int64

    Banner selection for the team

    created_at

    date-time

    Creation date of the team

    description

    string

    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

    is_managed

    boolean

    Whether the team is managed from an external source

    link_count

    int32

    The number of links belonging to the team

    modified_at

    date-time

    Modification date of the team

    name [required]

    string

    The name of the team

    summary

    string

    A brief summary of the team, derived from the description

    user_count

    int32

    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

    relationships

    object

    Resources related to a team

    team_links

    object

    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 Allowed enum values: team_links

    default: team_links

    links

    object

    Links attributes.

    related

    string

    Related link.

    user_team_permissions

    object

    Relationship between a user team permission and a team

    data

    object

    Related user team permission data

    id [required]

    string

    The ID of the user team permission

    type [required]

    enum

    User team permission type Allowed enum values: user_team_permissions

    default: user_team_permissions

    links

    object

    Links attributes.

    related

    string

    Related link.

    type [required]

    enum

    Team type Allowed enum values: team

    default: team

    {
      "data": {
        "attributes": {
          "avatar": "🥑",
          "banner": "integer",
          "created_at": "2019-09-19T10:00:00.000Z",
          "description": "string",
          "handle": "example-team",
          "hidden_modules": [],
          "is_managed": false,
          "link_count": "integer",
          "modified_at": "2019-09-19T10:00:00.000Z",
          "name": "Example Team",
          "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"
      }
    }

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    API error response.

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Code Example

                              ## default
    # 
    
    # Curl command
    curl -X POST "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/team" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "avatar": "🥑", "handle": "example-team", "name": "Example Team" }, "relationships": { "users": { "data": [] } }, "type": "team" } } EOF
                              ## default
    # 
    
    # Curl command
    curl -X POST "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/team" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "avatar": "🥑", "handle": "example-team", "name": "Example Team" }, "relationships": { "users": { "data": [] } }, "type": "team" } } EOF
    // Create a team returns "CREATED" 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() {
    	body := datadogV2.TeamCreateRequest{
    		Data: datadogV2.TeamCreate{
    			Attributes: datadogV2.TeamCreateAttributes{
    				Handle: "test-handle-a0fc0297eb519635",
    				Name:   "test-name-a0fc0297eb519635",
    			},
    			Relationships: &datadogV2.TeamCreateRelationships{
    				Users: &datadogV2.RelationshipToUsers{
    					Data: []datadogV2.RelationshipToUserData{},
    				},
    			},
    			Type: datadogV2.TEAMTYPE_TEAM,
    		},
    	}
    	ctx := datadog.NewDefaultContext(context.Background())
    	configuration := datadog.NewConfiguration()
    	apiClient := datadog.NewAPIClient(configuration)
    	api := datadogV2.NewTeamsApi(apiClient)
    	resp, r, err := api.CreateTeam(ctx, body)
    
    	if err != nil {
    		fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.CreateTeam`: %v\n", err)
    		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    	}
    
    	responseContent, _ := json.MarshalIndent(resp, "", "  ")
    	fmt.Fprintf(os.Stdout, "Response from `TeamsApi.CreateTeam`:\n%s\n", responseContent)
    }
    
    // Create a team with V2 fields returns "CREATED" 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() {
    	body := datadogV2.TeamCreateRequest{
    		Data: datadogV2.TeamCreate{
    			Attributes: datadogV2.TeamCreateAttributes{
    				Handle: "test-handle-a0fc0297eb519635",
    				Name:   "test-name-a0fc0297eb519635",
    				Avatar: *datadog.NewNullableString(datadog.PtrString("🥑")),
    				Banner: *datadog.NewNullableInt64(datadog.PtrInt64(7)),
    				VisibleModules: []string{
    					"m1",
    					"m2",
    				},
    				HiddenModules: []string{
    					"m3",
    				},
    			},
    			Type: datadogV2.TEAMTYPE_TEAM,
    		},
    	}
    	ctx := datadog.NewDefaultContext(context.Background())
    	configuration := datadog.NewConfiguration()
    	apiClient := datadog.NewAPIClient(configuration)
    	api := datadogV2.NewTeamsApi(apiClient)
    	resp, r, err := api.CreateTeam(ctx, body)
    
    	if err != nil {
    		fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.CreateTeam`: %v\n", err)
    		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    	}
    
    	responseContent, _ := json.MarshalIndent(resp, "", "  ")
    	fmt.Fprintf(os.Stdout, "Response from `TeamsApi.CreateTeam`:\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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
    // Create a team returns "CREATED" 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.RelationshipToUsers;
    import com.datadog.api.client.v2.model.TeamCreate;
    import com.datadog.api.client.v2.model.TeamCreateAttributes;
    import com.datadog.api.client.v2.model.TeamCreateRelationships;
    import com.datadog.api.client.v2.model.TeamCreateRequest;
    import com.datadog.api.client.v2.model.TeamResponse;
    import com.datadog.api.client.v2.model.TeamType;
    
    public class Example {
      public static void main(String[] args) {
        ApiClient defaultClient = ApiClient.getDefaultApiClient();
        TeamsApi apiInstance = new TeamsApi(defaultClient);
    
        TeamCreateRequest body =
            new TeamCreateRequest()
                .data(
                    new TeamCreate()
                        .attributes(
                            new TeamCreateAttributes()
                                .handle("test-handle-a0fc0297eb519635")
                                .name("test-name-a0fc0297eb519635"))
                        .relationships(new TeamCreateRelationships().users(new RelationshipToUsers()))
                        .type(TeamType.TEAM));
    
        try {
          TeamResponse result = apiInstance.createTeam(body);
          System.out.println(result);
        } catch (ApiException e) {
          System.err.println("Exception when calling TeamsApi#createTeam");
          System.err.println("Status code: " + e.getCode());
          System.err.println("Reason: " + e.getResponseBody());
          System.err.println("Response headers: " + e.getResponseHeaders());
          e.printStackTrace();
        }
      }
    }
    
    // Create a team with V2 fields returns "CREATED" 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.TeamCreate;
    import com.datadog.api.client.v2.model.TeamCreateAttributes;
    import com.datadog.api.client.v2.model.TeamCreateRequest;
    import com.datadog.api.client.v2.model.TeamResponse;
    import com.datadog.api.client.v2.model.TeamType;
    import java.util.Arrays;
    import java.util.Collections;
    
    public class Example {
      public static void main(String[] args) {
        ApiClient defaultClient = ApiClient.getDefaultApiClient();
        TeamsApi apiInstance = new TeamsApi(defaultClient);
    
        TeamCreateRequest body =
            new TeamCreateRequest()
                .data(
                    new TeamCreate()
                        .attributes(
                            new TeamCreateAttributes()
                                .handle("test-handle-a0fc0297eb519635")
                                .name("test-name-a0fc0297eb519635")
                                .avatar("🥑")
                                .banner(7L)
                                .visibleModules(Arrays.asList("m1", "m2"))
                                .hiddenModules(Collections.singletonList("m3")))
                        .type(TeamType.TEAM));
    
        try {
          TeamResponse result = apiInstance.createTeam(body);
          System.out.println(result);
        } catch (ApiException e) {
          System.err.println("Exception when calling TeamsApi#createTeam");
          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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
    """
    Create a team returns "CREATED" response
    """
    
    from datadog_api_client import ApiClient, Configuration
    from datadog_api_client.v2.api.teams_api import TeamsApi
    from datadog_api_client.v2.model.relationship_to_users import RelationshipToUsers
    from datadog_api_client.v2.model.team_create import TeamCreate
    from datadog_api_client.v2.model.team_create_attributes import TeamCreateAttributes
    from datadog_api_client.v2.model.team_create_relationships import TeamCreateRelationships
    from datadog_api_client.v2.model.team_create_request import TeamCreateRequest
    from datadog_api_client.v2.model.team_type import TeamType
    
    body = TeamCreateRequest(
        data=TeamCreate(
            attributes=TeamCreateAttributes(
                handle="test-handle-a0fc0297eb519635",
                name="test-name-a0fc0297eb519635",
            ),
            relationships=TeamCreateRelationships(
                users=RelationshipToUsers(
                    data=[],
                ),
            ),
            type=TeamType.TEAM,
        ),
    )
    
    configuration = Configuration()
    with ApiClient(configuration) as api_client:
        api_instance = TeamsApi(api_client)
        response = api_instance.create_team(body=body)
    
        print(response)
    
    """
    Create a team with V2 fields returns "CREATED" response
    """
    
    from datadog_api_client import ApiClient, Configuration
    from datadog_api_client.v2.api.teams_api import TeamsApi
    from datadog_api_client.v2.model.team_create import TeamCreate
    from datadog_api_client.v2.model.team_create_attributes import TeamCreateAttributes
    from datadog_api_client.v2.model.team_create_request import TeamCreateRequest
    from datadog_api_client.v2.model.team_type import TeamType
    
    body = TeamCreateRequest(
        data=TeamCreate(
            attributes=TeamCreateAttributes(
                handle="test-handle-a0fc0297eb519635",
                name="test-name-a0fc0297eb519635",
                avatar="🥑",
                banner=7,
                visible_modules=[
                    "m1",
                    "m2",
                ],
                hidden_modules=[
                    "m3",
                ],
            ),
            type=TeamType.TEAM,
        ),
    )
    
    configuration = Configuration()
    with ApiClient(configuration) as api_client:
        api_instance = TeamsApi(api_client)
        response = api_instance.create_team(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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
    # Create a team returns "CREATED" response
    
    require "datadog_api_client"
    api_instance = DatadogAPIClient::V2::TeamsAPI.new
    
    body = DatadogAPIClient::V2::TeamCreateRequest.new({
      data: DatadogAPIClient::V2::TeamCreate.new({
        attributes: DatadogAPIClient::V2::TeamCreateAttributes.new({
          handle: "test-handle-a0fc0297eb519635",
          name: "test-name-a0fc0297eb519635",
        }),
        relationships: DatadogAPIClient::V2::TeamCreateRelationships.new({
          users: DatadogAPIClient::V2::RelationshipToUsers.new({
            data: [],
          }),
        }),
        type: DatadogAPIClient::V2::TeamType::TEAM,
      }),
    })
    p api_instance.create_team(body)
    
    # Create a team with V2 fields returns "CREATED" response
    
    require "datadog_api_client"
    api_instance = DatadogAPIClient::V2::TeamsAPI.new
    
    body = DatadogAPIClient::V2::TeamCreateRequest.new({
      data: DatadogAPIClient::V2::TeamCreate.new({
        attributes: DatadogAPIClient::V2::TeamCreateAttributes.new({
          handle: "test-handle-a0fc0297eb519635",
          name: "test-name-a0fc0297eb519635",
          avatar: "🥑",
          banner: 7,
          visible_modules: [
            "m1",
            "m2",
          ],
          hidden_modules: [
            "m3",
          ],
        }),
        type: DatadogAPIClient::V2::TeamType::TEAM,
      }),
    })
    p api_instance.create_team(body)
    

    Instructions

    First install the library and its dependencies and then save the example to example.rb and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
    // Create a team returns "CREATED" response
    use datadog_api_client::datadog;
    use datadog_api_client::datadogV2::api_teams::TeamsAPI;
    use datadog_api_client::datadogV2::model::RelationshipToUsers;
    use datadog_api_client::datadogV2::model::TeamCreate;
    use datadog_api_client::datadogV2::model::TeamCreateAttributes;
    use datadog_api_client::datadogV2::model::TeamCreateRelationships;
    use datadog_api_client::datadogV2::model::TeamCreateRequest;
    use datadog_api_client::datadogV2::model::TeamType;
    
    #[tokio::main]
    async fn main() {
        let body = TeamCreateRequest::new(
            TeamCreate::new(
                TeamCreateAttributes::new(
                    "test-handle-a0fc0297eb519635".to_string(),
                    "test-name-a0fc0297eb519635".to_string(),
                ),
                TeamType::TEAM,
            )
            .relationships(TeamCreateRelationships::new().users(RelationshipToUsers::new(vec![]))),
        );
        let configuration = datadog::Configuration::new();
        let api = TeamsAPI::with_config(configuration);
        let resp = api.create_team(body).await;
        if let Ok(value) = resp {
            println!("{:#?}", value);
        } else {
            println!("{:#?}", resp.unwrap_err());
        }
    }
    
    // Create a team with V2 fields returns "CREATED" response
    use datadog_api_client::datadog;
    use datadog_api_client::datadogV2::api_teams::TeamsAPI;
    use datadog_api_client::datadogV2::model::TeamCreate;
    use datadog_api_client::datadogV2::model::TeamCreateAttributes;
    use datadog_api_client::datadogV2::model::TeamCreateRequest;
    use datadog_api_client::datadogV2::model::TeamType;
    
    #[tokio::main]
    async fn main() {
        let body = TeamCreateRequest::new(TeamCreate::new(
            TeamCreateAttributes::new(
                "test-handle-a0fc0297eb519635".to_string(),
                "test-name-a0fc0297eb519635".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.create_team(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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
    /**
     * Create a team returns "CREATED" response
     */
    
    import { client, v2 } from "@datadog/datadog-api-client";
    
    const configuration = client.createConfiguration();
    const apiInstance = new v2.TeamsApi(configuration);
    
    const params: v2.TeamsApiCreateTeamRequest = {
      body: {
        data: {
          attributes: {
            handle: "test-handle-a0fc0297eb519635",
            name: "test-name-a0fc0297eb519635",
          },
          relationships: {
            users: {
              data: [],
            },
          },
          type: "team",
        },
      },
    };
    
    apiInstance
      .createTeam(params)
      .then((data: v2.TeamResponse) => {
        console.log(
          "API called successfully. Returned data: " + JSON.stringify(data)
        );
      })
      .catch((error: any) => console.error(error));
    
    /**
     * Create a team with V2 fields returns "CREATED" response
     */
    
    import { client, v2 } from "@datadog/datadog-api-client";
    
    const configuration = client.createConfiguration();
    const apiInstance = new v2.TeamsApi(configuration);
    
    const params: v2.TeamsApiCreateTeamRequest = {
      body: {
        data: {
          attributes: {
            handle: "test-handle-a0fc0297eb519635",
            name: "test-name-a0fc0297eb519635",
            avatar: "🥑",
            banner: 7,
            visibleModules: ["m1", "m2"],
            hiddenModules: ["m3"],
          },
          type: "team",
        },
      },
    };
    
    apiInstance
      .createTeam(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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"