VictorOps
  1. Maintenance Mode
VictorOps
  • Alerts
    • Retrieve alert details.
      GET
  • Incidents
    • Get current incident information
      GET
    • Create a new incident
      POST
    • Acknowledge an incident or list of incidents
      PATCH
    • Acknowledge all incidents for which a user was paged.
      PATCH
    • Resolve all incidents for which a user was paged.
      PATCH
    • Reroute one or more incidents to one or more new routable destinations.
      POST
    • Resolve an incident or list of incidents
      PATCH
  • Maintenance Mode
    • Get an organization's current maintenance mode state
      GET
    • Start maintenance mode for routing keys
      POST
    • End maintenance mode for routing keys
      PUT
  • On-call
    • Get an organization's on-call users
      GET
    • Create an on-call override (take on-call)
      PATCH
    • Get a team's on-call schedule
      GET
    • Create an on-call override (take on-call)
      PATCH
    • Get a user's on-call schedule
      GET
    • Get a team's on-call schedule
      GET
    • Get a user's on-call schedule
      GET
  • Routing Keys
    • List routing keys with associated teams
      GET
  • Scheduled Overrides
    • List the scheduled overrides
      GET
    • Creates a new scheduled override
      POST
    • Deletes a scheduled override
      DELETE
    • Get the specified scheduled override
      GET
    • Get the specified scheduled override
      GET
    • Delete the scheduled override assignment
      DELETE
    • Get the specified scheduled override assignment
      GET
    • Update the scheduled override assignment
      PUT
  • Escalation Policies
    • Get escalation policy info
    • Retrieve a list of escalation policies for a team
  • Personal Paging Policy Values
    • Get the available contact types
    • Get the available notification types
    • Get the available timeout values
  • Personal Paging Policies
    • Get the user's paging policy
    • Create a paging policy step
    • Get a paging policy step
    • Create a rule for a paging policy step
    • Update a paging policy step
    • Delete a rule from a paging policy step
    • Get a rule from a paging policy step
    • Update a rule for a paging policy step
  • Teams
    • List teams
    • Add a team
    • Remove a team
    • Retrieve information for a team
    • Update a team
    • Retrieve a list of team admins for a team
    • Retrieve a list of members for a team
    • Add a team member
    • Remove a team member
  • Users
    • List users
    • Add a user
    • Remove a user
    • Retrieve information for a user
    • Update a user
    • Retrieve the user's team membership
  • User Contact Methods
    • Get a list of all contact methods for a user
    • Get a list of all contact devices for a user
    • Delete a contact device for a user
    • Get the indicated contact device for a user
    • Update a contact device for a user
    • Get a list of all contact emails for a user
    • Create a contact emails for a user
    • Delete a contact email for a user
    • Get the indicated contact email for a user
    • Get a list of all contact phones for a user
    • Create a contact phones for a user
    • Delete a contact phone for a user
    • Get the indicated contact phone for a user
  • User Paging Policies
    • Get a list of paging policies for a user
  • Reporting
    • Get/search incident history
    • A list of shift changes for a team
    • Get/search incident history
  1. Maintenance Mode

Start maintenance mode for routing keys

POST
/api-public/v1/maintenancemode/start
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.victorops.com//api-public/v1/maintenancemode/start' \
--header 'X-VO-Api-Id;' \
--header 'X-VO-Api-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "names": [
        "string"
    ],
    "purpose": "string",
    "type": "RoutingKeys"
}'
Response Response Example
200 - Example 1
{
    "activeInstances": [
        {
            "instanceId": "string",
            "isGlobal": true,
            "startedAt": 0,
            "startedBy": "string",
            "targets": [
                {
                    "names": [
                        "string"
                    ],
                    "type": "RoutingKeys"
                }
            ]
        }
    ],
    "companyId": "string"
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200maintenance mode state
application/json
Body

🟠403403
🟠409You have an active global maintanance mode and are attempting to start a second. You may only have a single Global maintenance mode at a time
🟠420You have reached the limit of allowed active maintenance modes
🔴500500
Modified at 2022-09-10 22:14:54
Previous
Get an organization's current maintenance mode state
Next
End maintenance mode for routing keys
Built with