--- title: Create a case description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Case Management --- # Create a case{% #create-a-case %} {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/cases | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/cases | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/cases | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/cases | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/cases | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/cases | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/cases | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/cases | ### Overview Create a Case OAuth apps require the `cases_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#case-management) to access this endpoint. ### Request #### Body Data (required) Case payload {% tab title="Model" %} | Parent field | Field | Type | Description | | -------------------- | ---------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Case creation data | | data | attributes [*required*] | object | Case creation attributes | | attributes | custom_attributes | object | Case custom attributes | | additionalProperties | | object | A typed value for a custom attribute on a specific case. | | | is_multi [*required*] | boolean | If true, value must be an array | | | type [*required*] | enum | The data type of the custom attribute, which determines the allowed values and UI input control. Allowed enum values: `URL,TEXT,NUMBER,SELECT` | | | value [*required*] | | The value of a custom attribute. The accepted format depends on the attribute's type and whether it accepts multiple values. | | value | Option 1 | string | A string value for a TEXT, URL, or SELECT-type custom attribute. | | value | Option 2 | [string] | An array of string values for a multi-value TEXT, URL, or SELECT-type custom attribute. | | value | Option 3 | double | A numeric value for a NUMBER-type custom attribute. | | value | Option 4 | [number] | An array of numeric values for a multi-value NUMBER-type custom attribute. | | attributes | description | string | Description | | attributes | priority | enum | Case priority Allowed enum values: `NOT_DEFINED,P1,P2,P3,P4,P5` | | attributes | status_name | string | Status of the case. Must be one of the existing statuses for the case's type. | | attributes | title [*required*] | string | Title | | attributes | type_id [*required*] | string | Case type UUID | | data | relationships | object | Relationships formed with the case on creation | | relationships | assignee | object | Relationship to user. | | assignee | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | User resource type. Allowed enum values: `user` | | relationships | project [*required*] | object | Relationship to project. | | project | data [*required*] | object | Relationship to project object. | | data | id [*required*] | string | A unique identifier that represents the project. | | data | type [*required*] | enum | Project resource type. Allowed enum values: `project` | | data | type [*required*] | enum | JSON:API resource type for cases. Allowed enum values: `case` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "priority": "NOT_DEFINED", "title": "Security breach investigation in 0cfbc5cbc676ee71", "type_id": "00000000-0000-0000-0000-000000000001" }, "relationships": { "assignee": { "data": { "id": "string", "type": "user" } }, "project": { "data": { "id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e", "type": "project" } } }, "type": "case" } } ``` {% /tab %} ### Response {% tab title="201" %} CREATED {% tab title="Model" %} Case response | Parent field | Field | Type | Description | | -------------------- | ---------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | A case | | data | attributes [*required*] | object | Case resource attributes | | attributes | archived_at | date-time | Timestamp of when the case was archived | | attributes | attributes | object | Key-value pairs of case attributes. Each key maps to an array of string values, used for flexible metadata such as labels or tags. | | additionalProperties | | [string] | | attributes | closed_at | date-time | Timestamp of when the case was closed | | attributes | created_at | date-time | Timestamp of when the case was created | | attributes | custom_attributes | object | Case custom attributes | | additionalProperties | | object | A typed value for a custom attribute on a specific case. | | | is_multi [*required*] | boolean | If true, value must be an array | | | type [*required*] | enum | The data type of the custom attribute, which determines the allowed values and UI input control. Allowed enum values: `URL,TEXT,NUMBER,SELECT` | | | value [*required*] | | The value of a custom attribute. The accepted format depends on the attribute's type and whether it accepts multiple values. | | value | Option 1 | string | A string value for a TEXT, URL, or SELECT-type custom attribute. | | value | Option 2 | [string] | An array of string values for a multi-value TEXT, URL, or SELECT-type custom attribute. | | value | Option 3 | double | A numeric value for a NUMBER-type custom attribute. | | value | Option 4 | [number] | An array of numeric values for a multi-value NUMBER-type custom attribute. | | attributes | description | string | Description | | attributes | jira_issue | object | Jira issue attached to case | | jira_issue | result | object | Jira issue information | | result | issue_id | string | Jira issue ID | | result | issue_key | string | Jira issue key | | result | issue_url | string | Jira issue URL | | result | project_key | string | Jira project key | | jira_issue | status | enum | Case status Allowed enum values: `IN_PROGRESS,COMPLETED,FAILED` | | attributes | key | string | Key | | attributes | modified_at | date-time | Timestamp of when the case was last modified | | attributes | priority | enum | Case priority Allowed enum values: `NOT_DEFINED,P1,P2,P3,P4,P5` | | attributes | service_now_ticket | object | ServiceNow ticket attached to case | | service_now_ticket | result | object | ServiceNow ticket information | | result | sys_target_link | string | Link to the Incident created on ServiceNow | | service_now_ticket | status | enum | Case status Allowed enum values: `IN_PROGRESS,COMPLETED,FAILED` | | attributes | status | enum | **DEPRECATED**: Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use `status_name` instead. Allowed enum values: `OPEN,IN_PROGRESS,CLOSED` | | attributes | status_group | enum | Status group of the case. Allowed enum values: `SG_OPEN,SG_IN_PROGRESS,SG_CLOSED` | | attributes | status_name | string | Status of the case. Must be one of the existing statuses for the case's type. | | attributes | title | string | Title | | attributes | type | enum | **DEPRECATED**: Case type Allowed enum values: `STANDARD` | | attributes | type_id | string | Case type UUID | | data | id [*required*] | string | Case's identifier | | data | relationships | object | Resources related to a case | | relationships | assignee | object | Relationship to user. | | assignee | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | User resource type. Allowed enum values: `user` | | relationships | created_by | object | Relationship to user. | | created_by | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | User resource type. Allowed enum values: `user` | | relationships | modified_by | object | Relationship to user. | | modified_by | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | User resource type. Allowed enum values: `user` | | relationships | project | object | Relationship to project. | | project | data [*required*] | object | Relationship to project object. | | data | id [*required*] | string | A unique identifier that represents the project. | | data | type [*required*] | enum | Project resource type. Allowed enum values: `project` | | data | type [*required*] | enum | JSON:API resource type for cases. Allowed enum values: `case` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "archived_at": "2019-09-19T10:00:00.000Z", "attributes": { "": [] }, "closed_at": "2019-09-19T10:00:00.000Z", "created_at": "2019-09-19T10:00:00.000Z", "custom_attributes": { "": { "is_multi": false, "type": "NUMBER", "value": { "description": "", "type": "" } } }, "description": "string", "jira_issue": { "result": { "issue_id": "string", "issue_key": "string", "issue_url": "string", "project_key": "string" }, "status": "COMPLETED" }, "key": "CASEM-4523", "modified_at": "2019-09-19T10:00:00.000Z", "priority": "NOT_DEFINED", "service_now_ticket": { "result": { "sys_target_link": "string" }, "status": "COMPLETED" }, "status": "OPEN", "status_group": "SG_OPEN", "status_name": "Open", "title": "Memory leak investigation on API", "type": "STANDARD", "type_id": "3b010bde-09ce-4449-b745-71dd5f861963" }, "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", "relationships": { "assignee": { "data": { "id": "00000000-0000-0000-0000-000000000000", "type": "user" } }, "created_by": { "data": { "id": "00000000-0000-0000-0000-000000000000", "type": "user" } }, "modified_by": { "data": { "id": "00000000-0000-0000-0000-000000000000", "type": "user" } }, "project": { "data": { "id": "e555e290-ed65-49bd-ae18-8acbfcf18db7", "type": "project" } } }, "type": "case" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/cases" \ -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": { "priority": "NOT_DEFINED", "status_name": "Open", "title": "Security breach investigation", "type_id": "3b010bde-09ce-4449-b745-71dd5f861963" }, "relationships": { "assignee": { "data": { "id": "00000000-0000-0000-0000-000000000000", "type": "user" } }, "project": { "data": { "id": "e555e290-ed65-49bd-ae18-8acbfcf18db7", "type": "project" } } }, "type": "case" } } EOF ##### ```go // Create a case 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() { // there is a valid "user" in the system UserDataID := os.Getenv("USER_DATA_ID") body := datadogV2.CaseCreateRequest{ Data: datadogV2.CaseCreate{ Attributes: datadogV2.CaseCreateAttributes{ Priority: datadogV2.CASEPRIORITY_NOT_DEFINED.Ptr(), Title: "Security breach investigation in 0cfbc5cbc676ee71", TypeId: "00000000-0000-0000-0000-000000000001", }, Relationships: &datadogV2.CaseCreateRelationships{ Assignee: *datadogV2.NewNullableNullableUserRelationship(&datadogV2.NullableUserRelationship{ Data: *datadogV2.NewNullableNullableUserRelationshipData(&datadogV2.NullableUserRelationshipData{ Id: UserDataID, Type: datadogV2.USERRESOURCETYPE_USER, }), }), Project: datadogV2.ProjectRelationship{ Data: datadogV2.ProjectRelationshipData{ Id: "d4bbe1af-f36e-42f1-87c1-493ca35c320e", Type: datadogV2.PROJECTRESOURCETYPE_PROJECT, }, }, }, Type: datadogV2.CASERESOURCETYPE_CASE, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewCaseManagementApi(apiClient) resp, r, err := api.CreateCase(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.CreateCase`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.CreateCase`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create a case returns "CREATED" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.CaseManagementApi; import com.datadog.api.client.v2.model.CaseCreate; import com.datadog.api.client.v2.model.CaseCreateAttributes; import com.datadog.api.client.v2.model.CaseCreateRelationships; import com.datadog.api.client.v2.model.CaseCreateRequest; import com.datadog.api.client.v2.model.CasePriority; import com.datadog.api.client.v2.model.CaseResourceType; import com.datadog.api.client.v2.model.CaseResponse; import com.datadog.api.client.v2.model.NullableUserRelationship; import com.datadog.api.client.v2.model.NullableUserRelationshipData; import com.datadog.api.client.v2.model.ProjectRelationship; import com.datadog.api.client.v2.model.ProjectRelationshipData; import com.datadog.api.client.v2.model.ProjectResourceType; import com.datadog.api.client.v2.model.UserResourceType; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); CaseManagementApi apiInstance = new CaseManagementApi(defaultClient); // there is a valid "user" in the system String USER_DATA_ID = System.getenv("USER_DATA_ID"); CaseCreateRequest body = new CaseCreateRequest() .data( new CaseCreate() .attributes( new CaseCreateAttributes() .priority(CasePriority.NOT_DEFINED) .title("Security breach investigation in 0cfbc5cbc676ee71") .typeId("00000000-0000-0000-0000-000000000001")) .relationships( new CaseCreateRelationships() .assignee( new NullableUserRelationship() .data( new NullableUserRelationshipData() .id(USER_DATA_ID) .type(UserResourceType.USER))) .project( new ProjectRelationship() .data( new ProjectRelationshipData() .id("d4bbe1af-f36e-42f1-87c1-493ca35c320e") .type(ProjectResourceType.PROJECT)))) .type(CaseResourceType.CASE)); try { CaseResponse result = apiInstance.createCase(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling CaseManagementApi#createCase"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Create a case returns "CREATED" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.case_management_api import CaseManagementApi from datadog_api_client.v2.model.case_create import CaseCreate from datadog_api_client.v2.model.case_create_attributes import CaseCreateAttributes from datadog_api_client.v2.model.case_create_relationships import CaseCreateRelationships from datadog_api_client.v2.model.case_create_request import CaseCreateRequest from datadog_api_client.v2.model.case_priority import CasePriority from datadog_api_client.v2.model.case_resource_type import CaseResourceType from datadog_api_client.v2.model.nullable_user_relationship import NullableUserRelationship from datadog_api_client.v2.model.nullable_user_relationship_data import NullableUserRelationshipData from datadog_api_client.v2.model.project_relationship import ProjectRelationship from datadog_api_client.v2.model.project_relationship_data import ProjectRelationshipData from datadog_api_client.v2.model.project_resource_type import ProjectResourceType from datadog_api_client.v2.model.user_resource_type import UserResourceType # there is a valid "user" in the system USER_DATA_ID = environ["USER_DATA_ID"] body = CaseCreateRequest( data=CaseCreate( attributes=CaseCreateAttributes( priority=CasePriority.NOT_DEFINED, title="Security breach investigation in 0cfbc5cbc676ee71", type_id="00000000-0000-0000-0000-000000000001", ), relationships=CaseCreateRelationships( assignee=NullableUserRelationship( data=NullableUserRelationshipData( id=USER_DATA_ID, type=UserResourceType.USER, ), ), project=ProjectRelationship( data=ProjectRelationshipData( id="d4bbe1af-f36e-42f1-87c1-493ca35c320e", type=ProjectResourceType.PROJECT, ), ), ), type=CaseResourceType.CASE, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = CaseManagementApi(api_client) response = api_instance.create_case(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Create a case returns "CREATED" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::CaseManagementAPI.new # there is a valid "user" in the system USER_DATA_ID = ENV["USER_DATA_ID"] body = DatadogAPIClient::V2::CaseCreateRequest.new({ data: DatadogAPIClient::V2::CaseCreate.new({ attributes: DatadogAPIClient::V2::CaseCreateAttributes.new({ priority: DatadogAPIClient::V2::CasePriority::NOT_DEFINED, title: "Security breach investigation in 0cfbc5cbc676ee71", type_id: "00000000-0000-0000-0000-000000000001", }), relationships: DatadogAPIClient::V2::CaseCreateRelationships.new({ assignee: DatadogAPIClient::V2::NullableUserRelationship.new({ data: DatadogAPIClient::V2::NullableUserRelationshipData.new({ id: USER_DATA_ID, type: DatadogAPIClient::V2::UserResourceType::USER, }), }), project: DatadogAPIClient::V2::ProjectRelationship.new({ data: DatadogAPIClient::V2::ProjectRelationshipData.new({ id: "d4bbe1af-f36e-42f1-87c1-493ca35c320e", type: DatadogAPIClient::V2::ProjectResourceType::PROJECT, }), }), }), type: DatadogAPIClient::V2::CaseResourceType::CASE, }), }) p api_instance.create_case(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Create a case returns "CREATED" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI; use datadog_api_client::datadogV2::model::CaseCreate; use datadog_api_client::datadogV2::model::CaseCreateAttributes; use datadog_api_client::datadogV2::model::CaseCreateRelationships; use datadog_api_client::datadogV2::model::CaseCreateRequest; use datadog_api_client::datadogV2::model::CasePriority; use datadog_api_client::datadogV2::model::CaseResourceType; use datadog_api_client::datadogV2::model::NullableUserRelationship; use datadog_api_client::datadogV2::model::NullableUserRelationshipData; use datadog_api_client::datadogV2::model::ProjectRelationship; use datadog_api_client::datadogV2::model::ProjectRelationshipData; use datadog_api_client::datadogV2::model::ProjectResourceType; use datadog_api_client::datadogV2::model::UserResourceType; #[tokio::main] async fn main() { // there is a valid "user" in the system let user_data_id = std::env::var("USER_DATA_ID").unwrap(); let body = CaseCreateRequest::new( CaseCreate::new( CaseCreateAttributes::new( "Security breach investigation in 0cfbc5cbc676ee71".to_string(), "00000000-0000-0000-0000-000000000001".to_string(), ) .priority(CasePriority::NOT_DEFINED), CaseResourceType::CASE, ) .relationships( CaseCreateRelationships::new(ProjectRelationship::new(ProjectRelationshipData::new( "d4bbe1af-f36e-42f1-87c1-493ca35c320e".to_string(), ProjectResourceType::PROJECT, ))) .assignee(Some(NullableUserRelationship::new(Some( NullableUserRelationshipData::new(user_data_id.clone(), UserResourceType::USER), )))), ), ); let configuration = datadog::Configuration::new(); let api = CaseManagementAPI::with_config(configuration); let resp = api.create_case(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create a case returns "CREATED" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.CaseManagementApi(configuration); // there is a valid "user" in the system const USER_DATA_ID = process.env.USER_DATA_ID as string; const params: v2.CaseManagementApiCreateCaseRequest = { body: { data: { attributes: { priority: "NOT_DEFINED", title: "Security breach investigation in 0cfbc5cbc676ee71", typeId: "00000000-0000-0000-0000-000000000001", }, relationships: { assignee: { data: { id: USER_DATA_ID, type: "user", }, }, project: { data: { id: "d4bbe1af-f36e-42f1-87c1-493ca35c320e", type: "project", }, }, }, type: "case", }, }, }; apiInstance .createCase(params) .then((data: v2.CaseResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}