Jump to

• Request
• Response

Suppress an incident

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/incidents/{incidentId}/actions/suppress

Suppresses a single incident matching the ID

Request

Path Parameters

• incidentId(required): string(raw)
  ID of the incident to suppress

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Suppression request payload

Show Source

• comment: string
  Minimum Length: 1

  Maximum Length: 4000

  Description for suppression action

  Example: Actively looking into the incident
• suppressUntil(required): string
  Allowed Values: [ "MANUALLY_UNSUPPRESSED", "INCIDENT_CLOSES", "INCIDENT_SEVERITY_CHANGES", "AFTER_A_DAY", "AFTER_A_WEEK", "AFTER_DATE" ]

  Supression types - Manually unsuppress, Incident closes, Incident severity changes, After a day, After a week, After a given date

  Example: AFTER_A_DAY
• timeToEndSuppression: string (date-time)
  Time to end the supression

  Example: 2021-05-25T13:41:32.230Z

{
    "required":[
        "suppressUntil"
    ],
    "type":"object",
    "properties":{
        "suppressUntil":{
            "type":"string",
            "description":"Supression types - Manually unsuppress, Incident closes, Incident severity changes, After a day, After a week, After a given date",
            "example":"AFTER_A_DAY",
            "enum":[
                "MANUALLY_UNSUPPRESSED",
                "INCIDENT_CLOSES",
                "INCIDENT_SEVERITY_CHANGES",
                "AFTER_A_DAY",
                "AFTER_A_WEEK",
                "AFTER_DATE"
            ]
        },
        "timeToEndSuppression":{
            "type":"string",
            "description":"Time to end the supression",
            "format":"date-time",
            "example":"2021-05-25T13:41:32.230Z"
        },
        "comment":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Description for suppression action",
            "example":"Actively looking into the incident"
        }
    },
    "description":"Suppression request payload"
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

Successful operation with no payload

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top