Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED

Seats

The seats API allows you to view, assign, and unassign seats for your organization.

Get users with seats

GET https://api.ap1.datadoghq.com/api/v2/seats/usershttps://api.ap2.datadoghq.com/api/v2/seats/usershttps://api.datadoghq.eu/api/v2/seats/usershttps://api.ddog-gov.com/api/v2/seats/usershttps://api.datadoghq.com/api/v2/seats/usershttps://api.us3.datadoghq.com/api/v2/seats/usershttps://api.us5.datadoghq.com/api/v2/seats/users

Overview

Get the list of users assigned seats for a product code. This endpoint requires any of the following permissions:

  • billing_read
  • incident_read
  • on_call_read

    • Arguments

    Query Strings

    Name

    Type

    Description

    product_code [required]

    string

    The product code for which to retrieve seat users.

    page[limit]

    integer

    Maximum number of results to return.

    page[cursor]

    string

    Cursor for pagination.

    Response

    OK

    Expand All

    Field

    Type

    Description

    data

    [object]

    The list of seat users.

    attributes

    object

    The attributes of the seat user.

    assigned_at

    date-time

    The date and time the seat was assigned.

    email

    string

    The email of the user.

    name

    string

    The name of the user.

    id

    string

    The ID of the seat user.

    type

    enum

    Seat users resource type. Allowed enum values: seat-users

    default: seat-users

    meta

    object

    The metadata of the seat users.

    cursor

    string

    The cursor for the seat users.

    limit

    int64

    The limit for the seat users.

    next_cursor

    string

    The next cursor for the seat users.

    {
  "data": [
    {
      "attributes": {
        "assigned_at": "2021-01-01T00:00:00Z",
        "email": "user@example.com",
        "name": "John Doe"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "seat-users"
    }
  ],
  "meta": {
    "cursor": "string",
    "limit": "integer",
    "next_cursor": "string"
  }
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Unprocessable Entity

    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

                      # Required query arguments
    export product_code="CHANGE_ME"
    # Curl command
    curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/seats/users?product_code=${product_code}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

    Assign seats to users

    POST https://api.ap1.datadoghq.com/api/v2/seats/usershttps://api.ap2.datadoghq.com/api/v2/seats/usershttps://api.datadoghq.eu/api/v2/seats/usershttps://api.ddog-gov.com/api/v2/seats/usershttps://api.datadoghq.com/api/v2/seats/usershttps://api.us3.datadoghq.com/api/v2/seats/usershttps://api.us5.datadoghq.com/api/v2/seats/users

    Overview

    Assign seats to users for a product code. This endpoint requires any of the following permissions:

  • billing_edit
  • incident_write
  • on_call_write

    • Request

    Body Data (required)

    Expand All

    Field

    Type

    Description

    data

    object

    The data for the assign seats user request.

    attributes [required]

    object

    The attributes of the assign seats user request.

    product_code [required]

    string

    The product code for which to assign seats.

    user_uuids [required]

    [string]

    The list of user IDs to assign seats to.

    id

    string

    The ID of the assign seats user request.

    type [required]

    enum

    The type of the assign seats user request. Allowed enum values: seat-assignments

    default: seat-assignments

    {
  "data": {
    "attributes": {
      "product_code": "",
      "user_uuids": [
        ""
      ]
    },
    "id": "string",
    "type": "seat-assignments"
  }
}

    Response

    Created

    Expand All

    Field

    Type

    Description

    data

    object

    The data for the assign seats user response.

    attributes

    object

    The attributes of the assign seats user response.

    assigned_ids

    [string]

    The list of user IDs to which the seats were assigned.

    product_code

    string

    The product code for which the seats were assigned.

    id

    string

    The ID of the assign seats user response.

    type

    enum

    Seat assignments resource type. Allowed enum values: seat-assignments

    default: seat-assignments

    {
  "data": {
    "attributes": {
      "assigned_ids": [],
      "product_code": "string"
    },
    "id": "string",
    "type": "seat-assignments"
  }
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Unprocessable Entity

    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

                      # 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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/seats/users" \
-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": {
      "product_code": "",
      "user_uuids": [
        ""
      ]
    },
    "type": "seat-assignments"
  }
}
EOF

    Unassign seats from users

    DELETE https://api.ap1.datadoghq.com/api/v2/seats/usershttps://api.ap2.datadoghq.com/api/v2/seats/usershttps://api.datadoghq.eu/api/v2/seats/usershttps://api.ddog-gov.com/api/v2/seats/usershttps://api.datadoghq.com/api/v2/seats/usershttps://api.us3.datadoghq.com/api/v2/seats/usershttps://api.us5.datadoghq.com/api/v2/seats/users

    Overview

    Unassign seats from users for a product code. This endpoint requires any of the following permissions:

  • billing_edit
  • incident_write
  • on_call_write

    • Request

    Body Data (required)

    Expand All

    Field

    Type

    Description

    data

    object

    The data for the unassign seats user request.

    attributes [required]

    object

    The attributes of the unassign seats user request.

    product_code [required]

    string

    The product code for which to unassign seats.

    user_uuids [required]

    [string]

    The list of user IDs to unassign seats from.

    id

    string

    The ID of the unassign seats user request.

    type [required]

    enum

    The type of the unassign seats user request. Allowed enum values: seat-assignments

    default: seat-assignments

    {
  "data": {
    "attributes": {
      "product_code": "",
      "user_uuids": [
        ""
      ]
    },
    "id": "string",
    "type": "seat-assignments"
  }
}

    Response

    No Content

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Unprocessable Entity

    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

                      # 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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/seats/users" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "product_code": "",
      "user_uuids": [
        ""
      ]
    },
    "type": "seat-assignments"
  }
}
EOF