v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Status Pages

Edit degradation update

Edits a specific degradation update.

patch/api/v2/statuspages/{page_id}/degradations/{degradation_id}/updates/{update_id}

Path parameters

degradation_idstring uuid required

The ID of the degradation.

page_idstring uuid required

The ID of the status page.

update_idstring uuid required

The ID of the degradation update.

Query parameters

includestring

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, degradation, status_page.

Request body

Example request

{
  "data": {
    "attributes": {
      "description": "We've identified the source of the latency increase and are deploying a fix.",
      "status": "identified"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "degradation_updates"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "components_affected": [
        {
          "status": "operational"
        }
      ],
      "status": "investigating"
    },
    "relationships": {
      "created_by_user": {
        "data": {
          "type": "users"
        }
      },
      "degradation": {
        "data": {
          "type": "degradations"
        }
      },
      "deleted_by_user": {
        "data": {
          "type": "users"
        }
      },
      "last_modified_by_user": {
        "data": {
          "type": "users"
        }
      },
      "status_page": {
        "data": {
          "type": "status_pages"
        }
      }
    },
    "type": "degradation_updates"
  },
  "included": [
    {
      "type": "users"
    }
  ]
}