Incidents

Update Incident

Updates an incident.

POST
/incidents.update

Authorization

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Request Body

acknowledged_date?string

Timestamp when the incident was acknowledged.

Formatdate-time
applies_to_parts?update-incident-applies-to-parts
artifacts?update-incident-artifacts
body?string

Body of the incident.

Formattext
custom_fields?object

Application-defined custom fields.

Empty Object

custom_schema_spec?custom-schema-spec

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

external_source_data?update-external-source-data-comp
idstring

The ID of the incident to be updated.

Formatid
identified_date?string

Time when the incident was identified/reported.

Formatdate-time
impact?update-impacted-customer-details
mitigated_date?string

Timestamp when the incident was mitigated.

Formatdate-time
owned_by?update-incident-owned-by
pia?update-incident-pia
playbooks?update-incident-playbooks
related_docs?update-incident-related-docs
reported_by?integer

The entity that first reported the incident.

Formatint64
severity?integer

Severity of the incident.

Formatint64
source?integerDeprecated

Source of where the incident was created. Only sys users and service accounts are supposed to set this field.

Formatint64
stage?update-stage

Update object for Stage.

stage_validation_options?array<stage-validation-option-for-update>

The type of stage validations options when updating the stage or the stage diagram of an incident.

staged_info?update-staged-info

Update object for StagedInfo.

sync_metadata?update-sync-metadata
tags?update-incident-tags
target_close_date?string

Timestamp when the incident is expected to be resolved.

Formatdate-time
title?string

Title of the incident.

Formattext

Response Body

curl -X POST "https://api.devrev.ai/incidents.update" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'
{
  "incident": {
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "acknowledged_date": "2023-01-01T12:00:00.000Z",
    "actual_close_date": "2023-01-01T12:00:00.000Z",
    "applies_to_parts": [
      {
        "type": "capability",
        "display_id": "string",
        "id": "string",
        "name": "string",
        "owned_by": [
          {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          }
        ],
        "sync_metadata": {
          "external_reference": "string",
          "origin_system": "string"
        }
      }
    ],
    "artifacts": [
      {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      }
    ],
    "body": "string",
    "custom_fields": {},
    "custom_schema_fragments": [
      "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
    ],
    "identified_date": "2023-01-01T12:00:00.000Z",
    "impact": {
      "count": {
        "id": 0,
        "label": "string",
        "ordinal": 0,
        "value": null
      },
      "customer_ids": [
        {
          "display_id": "string",
          "id": "string",
          "display_name": "string"
        }
      ]
    },
    "mitigated_date": "2023-01-01T12:00:00.000Z",
    "owned_by": [
      {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      }
    ],
    "pia": [
      {
        "display_id": "string",
        "id": "string",
        "article_type": "article",
        "resource": {
          "artifacts": [
            {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            }
          ],
          "url": "string"
        },
        "sync_metadata": {
          "external_reference": "string",
          "origin_system": "string"
        },
        "title": "string"
      }
    ],
    "playbooks": [
      {
        "display_id": "string",
        "id": "string",
        "article_type": "article",
        "resource": {
          "artifacts": [
            {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            }
          ],
          "url": "string"
        },
        "sync_metadata": {
          "external_reference": "string",
          "origin_system": "string"
        },
        "title": "string"
      }
    ],
    "reported_by": {
      "id": 0,
      "label": "string",
      "ordinal": 0,
      "value": null
    },
    "severity": {
      "id": 0,
      "label": "string",
      "ordinal": 0,
      "value": null
    },
    "source": {
      "id": 0,
      "label": "string",
      "ordinal": 0,
      "value": null
    },
    "stage": {
      "stage": {
        "display_id": "string",
        "id": "string",
        "name": "string"
      },
      "state": {
        "display_id": "string",
        "id": "string",
        "is_final": true,
        "name": "string"
      }
    },
    "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
    "subtype": "string",
    "sync_metadata": {
      "external_reference": "string",
      "last_sync_in": {
        "status": "failed",
        "sync_date": "2023-01-01T12:00:00.000Z",
        "sync_unit": {
          "display_id": "string",
          "id": "string",
          "external_system_type": "adaas",
          "is_archived": true,
          "name": "string",
          "sync_run": {
            "mode": "initial",
            "progress": {
              "state": "completed"
            }
          },
          "sync_type": "manual"
        }
      },
      "last_sync_out": {
        "status": "failed",
        "sync_date": "2023-01-01T12:00:00.000Z",
        "sync_unit": {
          "display_id": "string",
          "id": "string",
          "external_system_type": "adaas",
          "is_archived": true,
          "name": "string",
          "sync_run": {
            "mode": "initial",
            "progress": {
              "state": "completed"
            }
          },
          "sync_type": "manual"
        }
      },
      "origin_system": "string"
    },
    "tags": [
      {
        "tag": {
          "display_id": "string",
          "id": "string",
          "name": "string",
          "style_new": {
            "color": "string"
          }
        },
        "value": "string"
      }
    ],
    "target_close_date": "2023-01-01T12:00:00.000Z",
    "title": "string"
  }
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "not_found"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}