Language

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

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED

ServiceNow Integration

Manage your ServiceNow Integration. ServiceNow is a cloud-based platform that helps organizations manage digital workflows for enterprise operations.

Delete ServiceNow template

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

DELETE https://api.ap1.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.ap2.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.datadoghq.eu/api/v2/integration/servicenow/handles/{template_id}https://api.ddog-gov.com/api/v2/integration/servicenow/handles/{template_id}https://api.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.us3.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.us5.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}

Overview

Delete a ServiceNow template by ID.

Arguments

Path Parameters

Name

Type

Description

template_id [required]

string

The ID of the ServiceNow template to delete

Response

OK

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # Path parameters
export template_id="65b3341b-0680-47f9-a6d4-134db45c603e"
# 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/integration/servicenow/handles/${template_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Update ServiceNow template

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

PUT https://api.ap1.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.ap2.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.datadoghq.eu/api/v2/integration/servicenow/handles/{template_id}https://api.ddog-gov.com/api/v2/integration/servicenow/handles/{template_id}https://api.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.us3.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.us5.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}

Overview

Update a ServiceNow template by ID.

Arguments

Path Parameters

Name

Type

Description

template_id [required]

string

The ID of the ServiceNow template to update

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data object for updating a ServiceNow template

attributes [required]

object

Attributes for updating a ServiceNow template

assignment_group_id

uuid

The ID of the assignment group

business_service_id

uuid

The ID of the business service

fields_mapping

object

Custom field mappings for the template

<any-key>

string

handle_name [required]

string

The handle name of the template

instance_id [required]

uuid

The ID of the ServiceNow instance

servicenow_tablename [required]

string

The name of the destination ServiceNow table

user_id

uuid

The ID of the user

type [required]

enum

Type identifier for ServiceNow template resources Allowed enum values: servicenow_templates

{
  "data": {
    "attributes": {
      "assignment_group_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "business_service_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "fields_mapping": {
        "<any-key>": "string"
      },
      "handle_name": "incident-template-updated",
      "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "servicenow_tablename": "incident",
      "user_id": "65b3341b-0680-47f9-a6d4-134db45c603e"
    },
    "type": "servicenow_templates"
  }
}

Response

OK

Response containing a single ServiceNow template

Expand All

Field

Type

Description

data [required]

object

Data object for a ServiceNow template

attributes [required]

object

Attributes of a ServiceNow template

assignment_group_id

uuid

The ID of the assignment group

business_service_id

uuid

The ID of the business service

fields_mapping

object

Custom field mappings for the template

<any-key>

string

handle_name [required]

string

The handle name of the template

instance_id [required]

uuid

The ID of the ServiceNow instance

servicenow_tablename [required]

string

The name of the destination ServiceNow table

user_id

uuid

The ID of the user

id [required]

uuid

Unique identifier for the ServiceNow template

type [required]

enum

Type identifier for ServiceNow template resources Allowed enum values: servicenow_templates

{
  "data": {
    "attributes": {
      "assignment_group_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "business_service_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "fields_mapping": {
        "<any-key>": "string"
      },
      "handle_name": "incident-template",
      "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "servicenow_tablename": "incident",
      "user_id": "65b3341b-0680-47f9-a6d4-134db45c603e"
    },
    "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
    "type": "servicenow_templates"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # Path parameters
export template_id="65b3341b-0680-47f9-a6d4-134db45c603e"
# Curl command
curl -X PUT "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/integration/servicenow/handles/${template_id}" \
-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": {
      "handle_name": "incident-template-updated",
      "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "servicenow_tablename": "incident"
    },
    "type": "servicenow_templates"
  }
}
EOF

Get ServiceNow template

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.ap2.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.datadoghq.eu/api/v2/integration/servicenow/handles/{template_id}https://api.ddog-gov.com/api/v2/integration/servicenow/handles/{template_id}https://api.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.us3.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}https://api.us5.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}

Overview

Get a ServiceNow template by ID.

Arguments

Path Parameters

Name

Type

Description

template_id [required]

string

The ID of the ServiceNow template to retrieve

Response

OK

Response containing a single ServiceNow template

Expand All

Field

Type

Description

data [required]

object

Data object for a ServiceNow template

attributes [required]

object

Attributes of a ServiceNow template

assignment_group_id

uuid

The ID of the assignment group

business_service_id

uuid

The ID of the business service

fields_mapping

object

Custom field mappings for the template

<any-key>

string

handle_name [required]

string

The handle name of the template

instance_id [required]

uuid

The ID of the ServiceNow instance

servicenow_tablename [required]

string

The name of the destination ServiceNow table

user_id

uuid

The ID of the user

id [required]

uuid

Unique identifier for the ServiceNow template

type [required]

enum

Type identifier for ServiceNow template resources Allowed enum values: servicenow_templates

{
  "data": {
    "attributes": {
      "assignment_group_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "business_service_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "fields_mapping": {
        "<any-key>": "string"
      },
      "handle_name": "incident-template",
      "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "servicenow_tablename": "incident",
      "user_id": "65b3341b-0680-47f9-a6d4-134db45c603e"
    },
    "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
    "type": "servicenow_templates"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # Path parameters
export template_id="65b3341b-0680-47f9-a6d4-134db45c603e"
# 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/integration/servicenow/handles/${template_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Create ServiceNow template

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/integration/servicenow/handleshttps://api.ap2.datadoghq.com/api/v2/integration/servicenow/handleshttps://api.datadoghq.eu/api/v2/integration/servicenow/handleshttps://api.ddog-gov.com/api/v2/integration/servicenow/handleshttps://api.datadoghq.com/api/v2/integration/servicenow/handleshttps://api.us3.datadoghq.com/api/v2/integration/servicenow/handleshttps://api.us5.datadoghq.com/api/v2/integration/servicenow/handles

Overview

Create a new ServiceNow template.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data object for creating a ServiceNow template

attributes [required]

object

Attributes for creating a ServiceNow template

assignment_group_id

uuid

The ID of the assignment group

business_service_id

uuid

The ID of the business service

fields_mapping

object

Custom field mappings for the template

<any-key>

string

handle_name [required]

string

The handle name of the template

instance_id [required]

uuid

The ID of the ServiceNow instance

servicenow_tablename [required]

string

The name of the destination ServiceNow table

user_id

uuid

The ID of the user

type [required]

enum

Type identifier for ServiceNow template resources Allowed enum values: servicenow_templates

{
  "data": {
    "attributes": {
      "assignment_group_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "business_service_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "fields_mapping": {
        "<any-key>": "string"
      },
      "handle_name": "incident-template",
      "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "servicenow_tablename": "incident",
      "user_id": "65b3341b-0680-47f9-a6d4-134db45c603e"
    },
    "type": "servicenow_templates"
  }
}

Response

Created

Response containing a single ServiceNow template

Expand All

Field

Type

Description

data [required]

object

Data object for a ServiceNow template

attributes [required]

object

Attributes of a ServiceNow template

assignment_group_id

uuid

The ID of the assignment group

business_service_id

uuid

The ID of the business service

fields_mapping

object

Custom field mappings for the template

<any-key>

string

handle_name [required]

string

The handle name of the template

instance_id [required]

uuid

The ID of the ServiceNow instance

servicenow_tablename [required]

string

The name of the destination ServiceNow table

user_id

uuid

The ID of the user

id [required]

uuid

Unique identifier for the ServiceNow template

type [required]

enum

Type identifier for ServiceNow template resources Allowed enum values: servicenow_templates

{
  "data": {
    "attributes": {
      "assignment_group_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "business_service_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "fields_mapping": {
        "<any-key>": "string"
      },
      "handle_name": "incident-template",
      "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "servicenow_tablename": "incident",
      "user_id": "65b3341b-0680-47f9-a6d4-134db45c603e"
    },
    "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
    "type": "servicenow_templates"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

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/integration/servicenow/handles" \
-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": {
      "handle_name": "incident-template",
      "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "servicenow_tablename": "incident"
    },
    "type": "servicenow_templates"
  }
}
EOF

List ServiceNow templates

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/integration/servicenow/handleshttps://api.ap2.datadoghq.com/api/v2/integration/servicenow/handleshttps://api.datadoghq.eu/api/v2/integration/servicenow/handleshttps://api.ddog-gov.com/api/v2/integration/servicenow/handleshttps://api.datadoghq.com/api/v2/integration/servicenow/handleshttps://api.us3.datadoghq.com/api/v2/integration/servicenow/handleshttps://api.us5.datadoghq.com/api/v2/integration/servicenow/handles

Overview

Get all ServiceNow templates for the organization.

Response

OK

Response containing ServiceNow templates

Expand All

Field

Type

Description

data [required]

[object]

Array of ServiceNow template data objects

attributes [required]

object

Attributes of a ServiceNow template

assignment_group_id

uuid

The ID of the assignment group

business_service_id

uuid

The ID of the business service

fields_mapping

object

Custom field mappings for the template

<any-key>

string

handle_name [required]

string

The handle name of the template

instance_id [required]

uuid

The ID of the ServiceNow instance

servicenow_tablename [required]

string

The name of the destination ServiceNow table

user_id

uuid

The ID of the user

id [required]

uuid

Unique identifier for the ServiceNow template

type [required]

enum

Type identifier for ServiceNow template resources Allowed enum values: servicenow_templates

{
  "data": [
    {
      "attributes": {
        "assignment_group_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
        "business_service_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
        "fields_mapping": {
          "<any-key>": "string"
        },
        "handle_name": "incident-template",
        "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
        "servicenow_tablename": "incident",
        "user_id": "65b3341b-0680-47f9-a6d4-134db45c603e"
      },
      "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "type": "servicenow_templates"
    }
  ]
}

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 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/integration/servicenow/handles" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List ServiceNow assignment groups

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/integration/servicenow/assignment_groups/{instance_id}https://api.ap2.datadoghq.com/api/v2/integration/servicenow/assignment_groups/{instance_id}https://api.datadoghq.eu/api/v2/integration/servicenow/assignment_groups/{instance_id}https://api.ddog-gov.com/api/v2/integration/servicenow/assignment_groups/{instance_id}https://api.datadoghq.com/api/v2/integration/servicenow/assignment_groups/{instance_id}https://api.us3.datadoghq.com/api/v2/integration/servicenow/assignment_groups/{instance_id}https://api.us5.datadoghq.com/api/v2/integration/servicenow/assignment_groups/{instance_id}

Overview

Get all assignment groups for a ServiceNow instance.

Arguments

Path Parameters

Name

Type

Description

instance_id [required]

string

The ID of the ServiceNow instance

Response

OK

Response containing ServiceNow assignment groups

Expand All

Field

Type

Description

data [required]

[object]

Array of ServiceNow assignment group data objects

attributes [required]

object

Attributes of a ServiceNow assignment group

assignment_group_name [required]

string

The name of the assignment group

assignment_group_sys_id [required]

string

The system ID of the assignment group in ServiceNow

instance_id [required]

uuid

The ID of the ServiceNow instance

id [required]

uuid

Unique identifier for the ServiceNow assignment group

type [required]

enum

Type identifier for ServiceNow assignment group resources Allowed enum values: assignment_groups

{
  "data": [
    {
      "attributes": {
        "assignment_group_name": "Network Team",
        "assignment_group_sys_id": "abc123def456",
        "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e"
      },
      "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "type": "assignment_groups"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # Path parameters
export instance_id="65b3341b-0680-47f9-a6d4-134db45c603e"
# 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/integration/servicenow/assignment_groups/${instance_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List ServiceNow business services

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/integration/servicenow/business_services/{instance_id}https://api.ap2.datadoghq.com/api/v2/integration/servicenow/business_services/{instance_id}https://api.datadoghq.eu/api/v2/integration/servicenow/business_services/{instance_id}https://api.ddog-gov.com/api/v2/integration/servicenow/business_services/{instance_id}https://api.datadoghq.com/api/v2/integration/servicenow/business_services/{instance_id}https://api.us3.datadoghq.com/api/v2/integration/servicenow/business_services/{instance_id}https://api.us5.datadoghq.com/api/v2/integration/servicenow/business_services/{instance_id}

Overview

Get all business services for a ServiceNow instance.

Arguments

Path Parameters

Name

Type

Description

instance_id [required]

string

The ID of the ServiceNow instance

Response

OK

Response containing ServiceNow business services

Expand All

Field

Type

Description

data [required]

[object]

Array of ServiceNow business service data objects

attributes [required]

object

Attributes of a ServiceNow business service

instance_id [required]

uuid

The ID of the ServiceNow instance

service_name [required]

string

The name of the business service

service_sys_id [required]

string

The system ID of the business service in ServiceNow

id [required]

uuid

Unique identifier for the ServiceNow business service

type [required]

enum

Type identifier for ServiceNow business service resources Allowed enum values: business_services

{
  "data": [
    {
      "attributes": {
        "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
        "service_name": "IT Support",
        "service_sys_id": "abc123def456"
      },
      "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "type": "business_services"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # Path parameters
export instance_id="65b3341b-0680-47f9-a6d4-134db45c603e"
# 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/integration/servicenow/business_services/${instance_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List ServiceNow users

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/integration/servicenow/users/{instance_id}https://api.ap2.datadoghq.com/api/v2/integration/servicenow/users/{instance_id}https://api.datadoghq.eu/api/v2/integration/servicenow/users/{instance_id}https://api.ddog-gov.com/api/v2/integration/servicenow/users/{instance_id}https://api.datadoghq.com/api/v2/integration/servicenow/users/{instance_id}https://api.us3.datadoghq.com/api/v2/integration/servicenow/users/{instance_id}https://api.us5.datadoghq.com/api/v2/integration/servicenow/users/{instance_id}

Overview

Get all users for a ServiceNow instance.

Arguments

Path Parameters

Name

Type

Description

instance_id [required]

string

The ID of the ServiceNow instance

Response

OK

Response containing ServiceNow users

Expand All

Field

Type

Description

data [required]

[object]

Array of ServiceNow user data objects

attributes [required]

object

Attributes of a ServiceNow user

email [required]

string

The email address of the user

full_name

string

The full name of the user

instance_id [required]

uuid

The ID of the ServiceNow instance

user_name [required]

string

The username of the ServiceNow user

user_sys_id [required]

string

The system ID of the user in ServiceNow

id [required]

uuid

Unique identifier for the ServiceNow user

type [required]

enum

Type identifier for ServiceNow user resources Allowed enum values: users

{
  "data": [
    {
      "attributes": {
        "email": "john.doe@example.com",
        "full_name": "John Doe",
        "instance_id": "65b3341b-0680-47f9-a6d4-134db45c603e",
        "user_name": "john.doe",
        "user_sys_id": "abc123def456"
      },
      "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "type": "users"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # Path parameters
export instance_id="65b3341b-0680-47f9-a6d4-134db45c603e"
# 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/integration/servicenow/users/${instance_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List ServiceNow instances

Note: This endpoint is in public beta and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/integration/servicenow/instanceshttps://api.ap2.datadoghq.com/api/v2/integration/servicenow/instanceshttps://api.datadoghq.eu/api/v2/integration/servicenow/instanceshttps://api.ddog-gov.com/api/v2/integration/servicenow/instanceshttps://api.datadoghq.com/api/v2/integration/servicenow/instanceshttps://api.us3.datadoghq.com/api/v2/integration/servicenow/instanceshttps://api.us5.datadoghq.com/api/v2/integration/servicenow/instances

Overview

Get all ServiceNow instances for the organization.

Response

OK

Response containing ServiceNow instances

Expand All

Field

Type

Description

data [required]

[object]

Array of ServiceNow instance data objects

attributes [required]

object

Attributes of a ServiceNow instance

instance_name [required]

string

The name of the ServiceNow instance

id [required]

uuid

Unique identifier for the ServiceNow instance

type [required]

enum

Type identifier for ServiceNow instance resources Allowed enum values: instance

{
  "data": [
    {
      "attributes": {
        "instance_name": "my-servicenow-instance"
      },
      "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
      "type": "instance"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # 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/integration/servicenow/instances" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"