{"files":{"SKILL.md":"---\nname: victorops-api\ndescription: \"VictorOps API skill. Use when working with VictorOps for api-public, api-reporting. Covers 96 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# VictorOps API\nAPI version: 0.0.3\n\n## Auth\nApiKey X-VO-Api-Key in header\n\n## Base URL\nhttps://api.victorops.com/\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /api-public/v1/user -- list users\n3. POST /api-public/v1/user -- create first user\n\n## Endpoints\n96 endpoints across 2 groups. See references/api-spec.lap for full details.\n\n### Api-public\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /api-public/v1/user | Add a user |\n| GET | /api-public/v1/user | List users |\n| GET | /api-public/v2/user | List users |\n| POST | /api-public/v1/user/batch | Add multiple users |\n| GET | /api-public/v1/user/{user} | Retrieve information for a user |\n| PUT | /api-public/v1/user/{user} | Update a user |\n| DELETE | /api-public/v1/user/{user} | Remove a user |\n| GET | /api-public/v1/user/{user}/teams | Retrieve the user's team membership |\n| GET | /api-public/v1/policies/types/notifications | Get the available notification types |\n| GET | /api-public/v1/policies/types/contacts | Get the available contact types |\n| GET | /api-public/v1/policies/types/timeouts | Get the available timeout values |\n| GET | /api-public/v1/profile/{username}/policies | Get the user's primary paging policy |\n| POST | /api-public/v1/profile/{username}/policies | Create a paging policy step |\n| GET | /api-public/v1/profile/{username}/policies/{step} | Get a paging policy step |\n| PUT | /api-public/v1/profile/{username}/policies/{step} | Update a paging policy step |\n| POST | /api-public/v1/profile/{username}/policies/{step} | Create a rule for a paging policy step |\n| GET | /api-public/v1/profile/{username}/policies/{step}/{rule} | Get a rule from a paging policy step |\n| PUT | /api-public/v1/profile/{username}/policies/{step}/{rule} | Update a rule for a paging policy step |\n| DELETE | /api-public/v1/profile/{username}/policies/{step}/{rule} | Delete a rule from a paging policy step |\n| GET | /api-public/v2/profile/{username}/policies | Get the user's paging policies |\n| GET | /api-public/v1/user/{user}/contact-methods | Get a list of all contact methods for a user |\n| GET | /api-public/v1/user/{user}/contact-methods/devices | Get a list of all contact devices for a user |\n| GET | /api-public/v1/user/{user}/contact-methods/devices/{contactId} | Get the indicated contact device for a user |\n| PUT | /api-public/v1/user/{user}/contact-methods/devices/{contactId} | Update a contact device for a user |\n| DELETE | /api-public/v1/user/{user}/contact-methods/devices/{contactId} | Delete a contact device for a user |\n| GET | /api-public/v1/user/{user}/contact-methods/emails | Get a list of all contact emails for a user |\n| POST | /api-public/v1/user/{user}/contact-methods/emails | Create a contact emails for a user |\n| GET | /api-public/v1/user/{user}/contact-methods/emails/{contactId} | Get the indicated contact email for a user |\n| DELETE | /api-public/v1/user/{user}/contact-methods/emails/{contactId} | Delete a contact email for a user |\n| GET | /api-public/v1/user/{user}/contact-methods/phones | Get a list of all contact phones for a user |\n| POST | /api-public/v1/user/{user}/contact-methods/phones | Create a contact phones for a user |\n| GET | /api-public/v1/user/{user}/contact-methods/phones/{contactId} | Get the indicated contact phone for a user |\n| DELETE | /api-public/v1/user/{user}/contact-methods/phones/{contactId} | Delete a contact phone for a user |\n| GET | /api-public/v1/user/{user}/policies | Get a list of paging policies for a user |\n| GET | /api-public/v1/user/{user}/oncall/schedule | Get a user's on-call schedule |\n| GET | /api-public/v2/user/{user}/oncall/schedule | Get a user's on-call schedule |\n| GET | /api-public/v1/team/{team}/oncall/schedule | Get a team's on-call schedule |\n| GET | /api-public/v2/team/{team}/oncall/schedule | Get a team's on-call schedule |\n| GET | /api-public/v1/oncall/current | Get an organization's on-call users |\n| PATCH | /api-public/v1/team/{team}/oncall/user | Create an on-call override (take on-call) |\n| PATCH | /api-public/v1/policies/{policy}/oncall/user | Create an on-call override (take on-call) |\n| GET | /api-public/v1/incidents/{incidentNumber} | Get a single incident |\n| GET | /api-public/v1/incidents | Get current incident information |\n| POST | /api-public/v1/incidents | Create a new incident |\n| PATCH | /api-public/v1/incidents/ack | Acknowledge an incident or list of incidents |\n| POST | /api-public/v1/incidents/reroute | Reroute one or more incidents to one or more new routable destinations. |\n| PATCH | /api-public/v1/incidents/resolve | Resolve an incident or list of incidents |\n| PATCH | /api-public/v1/incidents/byUser/ack | Acknowledge all incidents for which a user was paged. |\n| PATCH | /api-public/v1/incidents/byUser/resolve | Resolve all incidents for which a user was paged. |\n| GET | /api-public/v1/incidents/{incidentNumber}/notes | Get the notes associated with an incident |\n| POST | /api-public/v1/incidents/{incidentNumber}/notes | Create a new Note |\n| PUT | /api-public/v1/incidents/{incidentNumber}/notes/{noteName} | Update a Note |\n| DELETE | /api-public/v1/incidents/{incidentNumber}/notes/{noteName} | Delete a Note |\n| GET | /api-public/v1/alerts/{uuid} | Retrieve alert details. |\n| GET | /api-public/v1/org/routing-keys | List routing keys with associated teams |\n| POST | /api-public/v1/org/routing-keys | Create a new routing key |\n| GET | /api-public/v1/overrides | List the scheduled overrides |\n| POST | /api-public/v1/overrides | Creates a new scheduled override |\n| GET | /api-public/v1/overrides/{publicId} | Get the specified scheduled override |\n| DELETE | /api-public/v1/overrides/{publicId} | Deletes a scheduled override |\n| GET | /api-public/v1/overrides/{publicId}/assignments | Get the specified scheduled override |\n| GET | /api-public/v1/overrides/{publicId}/assignments/{policySlug} | Get the specified scheduled override assignment |\n| PUT | /api-public/v1/overrides/{publicId}/assignments/{policySlug} | Update the scheduled override assignment |\n| DELETE | /api-public/v1/overrides/{publicId}/assignments/{policySlug} | Delete the scheduled override assignment |\n| GET | /api-public/v1/teams/{team}/rotations | Get all rotation groups for a team |\n| POST | /api-public/v1/teams/{team}/rotations | Create a rotation group |\n| DELETE | /api-public/v1/teams/{team}/rotations/{groupId} | Delete a rotation group |\n| GET | /api-public/v1/teams/{team}/rotations/{groupId}/{shiftId}/scheduled | Get the scheduled user for a shift |\n| PUT | /api-public/v1/teams/{team}/rotations/{groupId}/{shiftId}/scheduled | Set the scheduled user for a shift |\n| GET | /api-public/v2/team/{team}/rotations | Get all rotations and some rotation details for a team |\n| GET | /api-public/v1/webhooks | Get all of your organization's webhooks |\n| GET | /api-public/v1/policies | Get a list of escalation policy info |\n| POST | /api-public/v1/policies | Create an escalation policy |\n| GET | /api-public/v1/policies/{policy} | Get a specific escalation policy |\n| DELETE | /api-public/v1/policies/{policy} | Delete a specified escalation policy |\n| POST | /api-public/v1/team | Add a team |\n| GET | /api-public/v1/team | List teams |\n| GET | /api-public/v1/team/{team} | Retrieve information for a team |\n| PUT | /api-public/v1/team/{team} | Update a team |\n| DELETE | /api-public/v1/team/{team} | Remove a team |\n| GET | /api-public/v1/team/{team}/policies | Retrieve a list of escalation policies for a team |\n| GET | /api-public/v1/team/{team}/admins | Retrieve a list of team admins for a team |\n| GET | /api-public/v1/team/{team}/members | Retrieve a list of members for a team |\n| POST | /api-public/v1/team/{team}/members | Add a team member |\n| DELETE | /api-public/v1/team/{team}/members/{user} | Remove a team member |\n| GET | /api-public/v1/maintenancemode | Get an organization's current maintenance mode state |\n| POST | /api-public/v1/maintenancemode/start | Start maintenance mode for routing keys |\n| PUT | /api-public/v1/maintenancemode/{maintenancemodeid}/end | End maintenance mode for routing keys |\n| POST | /api-public/v1/chat | Send a chat message into VictorOps |\n| POST | /api-public/v1/stakeholders/sendMessage | Sends a stakeholder message to the recipients. Recipients can either be User/team or both. |\n| GET | /api-public/v1/alertRules | Get all alert rules |\n| POST | /api-public/v1/alertRules | Create alert rule |\n| PUT | /api-public/v1/alertRules/{ruleId} | Update alert rule |\n| DELETE | /api-public/v1/alertRules/{ruleId} | Delete alert rule |\n\n### Api-reporting\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /api-reporting/v1/team/{team}/oncall/log | A list of shift changes for a team |\n| GET | /api-reporting/v2/incidents | Get/search incident history |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Create a user?\" -> POST /api-public/v1/user\n- \"List all user?\" -> GET /api-public/v1/user\n- \"Create a batch?\" -> POST /api-public/v1/user/batch\n- \"Get user details?\" -> GET /api-public/v1/user/{user}\n- \"Update a user?\" -> PUT /api-public/v1/user/{user}\n- \"Delete a user?\" -> DELETE /api-public/v1/user/{user}\n- \"List all teams?\" -> GET /api-public/v1/user/{user}/teams\n- \"List all notifications?\" -> GET /api-public/v1/policies/types/notifications\n- \"List all contacts?\" -> GET /api-public/v1/policies/types/contacts\n- \"List all timeouts?\" -> GET /api-public/v1/policies/types/timeouts\n- \"List all policies?\" -> GET /api-public/v1/profile/{username}/policies\n- \"Create a policy?\" -> POST /api-public/v1/profile/{username}/policies\n- \"Get policy details?\" -> GET /api-public/v1/profile/{username}/policies/{step}\n- \"Update a policy?\" -> PUT /api-public/v1/profile/{username}/policies/{step}\n- \"Delete a policy?\" -> DELETE /api-public/v1/profile/{username}/policies/{step}/{rule}\n- \"List all contact-methods?\" -> GET /api-public/v1/user/{user}/contact-methods\n- \"List all devices?\" -> GET /api-public/v1/user/{user}/contact-methods/devices\n- \"Get device details?\" -> GET /api-public/v1/user/{user}/contact-methods/devices/{contactId}\n- \"Update a device?\" -> PUT /api-public/v1/user/{user}/contact-methods/devices/{contactId}\n- \"Delete a device?\" -> DELETE /api-public/v1/user/{user}/contact-methods/devices/{contactId}\n- \"List all emails?\" -> GET /api-public/v1/user/{user}/contact-methods/emails\n- \"Create a email?\" -> POST /api-public/v1/user/{user}/contact-methods/emails\n- \"Get email details?\" -> GET /api-public/v1/user/{user}/contact-methods/emails/{contactId}\n- \"Delete a email?\" -> DELETE /api-public/v1/user/{user}/contact-methods/emails/{contactId}\n- \"List all phones?\" -> GET /api-public/v1/user/{user}/contact-methods/phones\n- \"Create a phone?\" -> POST /api-public/v1/user/{user}/contact-methods/phones\n- \"Get phone details?\" -> GET /api-public/v1/user/{user}/contact-methods/phones/{contactId}\n- \"Delete a phone?\" -> DELETE /api-public/v1/user/{user}/contact-methods/phones/{contactId}\n- \"List all schedule?\" -> GET /api-public/v1/user/{user}/oncall/schedule\n- \"List all current?\" -> GET /api-public/v1/oncall/current\n- \"List all log?\" -> GET /api-reporting/v1/team/{team}/oncall/log\n- \"Get incident details?\" -> GET /api-public/v1/incidents/{incidentNumber}\n- \"List all incidents?\" -> GET /api-public/v1/incidents\n- \"Create a incident?\" -> POST /api-public/v1/incidents\n- \"Create a reroute?\" -> POST /api-public/v1/incidents/reroute\n- \"List all notes?\" -> GET /api-public/v1/incidents/{incidentNumber}/notes\n- \"Create a note?\" -> POST /api-public/v1/incidents/{incidentNumber}/notes\n- \"Update a note?\" -> PUT /api-public/v1/incidents/{incidentNumber}/notes/{noteName}\n- \"Delete a note?\" -> DELETE /api-public/v1/incidents/{incidentNumber}/notes/{noteName}\n- \"Get alert details?\" -> GET /api-public/v1/alerts/{uuid}\n- \"List all routing-keys?\" -> GET /api-public/v1/org/routing-keys\n- \"Create a routing-key?\" -> POST /api-public/v1/org/routing-keys\n- \"List all overrides?\" -> GET /api-public/v1/overrides\n- \"Create a override?\" -> POST /api-public/v1/overrides\n- \"Get override details?\" -> GET /api-public/v1/overrides/{publicId}\n- \"Delete a override?\" -> DELETE /api-public/v1/overrides/{publicId}\n- \"List all assignments?\" -> GET /api-public/v1/overrides/{publicId}/assignments\n- \"Get assignment details?\" -> GET /api-public/v1/overrides/{publicId}/assignments/{policySlug}\n- \"Update a assignment?\" -> PUT /api-public/v1/overrides/{publicId}/assignments/{policySlug}\n- \"Delete a assignment?\" -> DELETE /api-public/v1/overrides/{publicId}/assignments/{policySlug}\n- \"List all rotations?\" -> GET /api-public/v1/teams/{team}/rotations\n- \"Create a rotation?\" -> POST /api-public/v1/teams/{team}/rotations\n- \"Delete a rotation?\" -> DELETE /api-public/v1/teams/{team}/rotations/{groupId}\n- \"List all scheduled?\" -> GET /api-public/v1/teams/{team}/rotations/{groupId}/{shiftId}/scheduled\n- \"List all webhooks?\" -> GET /api-public/v1/webhooks\n- \"Create a team?\" -> POST /api-public/v1/team\n- \"List all team?\" -> GET /api-public/v1/team\n- \"Get team details?\" -> GET /api-public/v1/team/{team}\n- \"Update a team?\" -> PUT /api-public/v1/team/{team}\n- \"Delete a team?\" -> DELETE /api-public/v1/team/{team}\n- \"List all admins?\" -> GET /api-public/v1/team/{team}/admins\n- \"List all members?\" -> GET /api-public/v1/team/{team}/members\n- \"Create a member?\" -> POST /api-public/v1/team/{team}/members\n- \"Delete a member?\" -> DELETE /api-public/v1/team/{team}/members/{user}\n- \"List all maintenancemode?\" -> GET /api-public/v1/maintenancemode\n- \"Create a start?\" -> POST /api-public/v1/maintenancemode/start\n- \"Create a chat?\" -> POST /api-public/v1/chat\n- \"Create a sendMessage?\" -> POST /api-public/v1/stakeholders/sendMessage\n- \"List all alertRules?\" -> GET /api-public/v1/alertRules\n- \"Create a alertRule?\" -> POST /api-public/v1/alertRules\n- \"Update a alertRule?\" -> PUT /api-public/v1/alertRules/{ruleId}\n- \"Delete a alertRule?\" -> DELETE /api-public/v1/alertRules/{ruleId}\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api VictorOps API\n@base https://api.victorops.com/\n@version 0.0.3\n@auth ApiKey X-VO-Api-Key in header\n@common_fields {X-VO-Api-Id: any # Your API ID, X-VO-Api-Key: any # Your API Key}\n@endpoints 96\n@hint download_for_search\n@toc api-public(94), api-reporting(2)\n\n@group api-public\n@endpoint POST /api-public/v1/user\n@desc Add a user\n@required {body: any}\n@returns(200) Some details about the user that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 409: The requested username or email address is not available, 422, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user\n@desc List users\n@returns(200) A list of users for your organization\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 422: You have reached your user limit, 500: Internal Server Error}\n\n@endpoint GET /api-public/v2/user\n@desc List users\n@optional {email: any # An email address with which to search for users}\n@returns(200) A list of the users in your organization. If the `email` parameter is present, the response is the list of users in your organization with a matching email address.\n@errors {400: Problem with the request arguments. The `email` request parameter must be at least three (3) characters long, if present., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/user/batch\n@desc Add multiple users\n@optional {users: [any]}\n@returns(200) The users were added, for errors, please see the response body\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 409: The requested username or email address is not available, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}\n@desc Retrieve information for a user\n@required {user: any # The VictorOps user to fetch}\n@returns(200) Some details about the user that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 422: Username or email is unavailable, or you have reached your user limit., 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/user/{user}\n@desc Update a user\n@required {user: any # The VictorOps user to be updated, body: map}\n@returns(200) Some details about the user that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 409: The requested username or email address is not available, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/user/{user}\n@desc Remove a user\n@required {user: any # The VictorOps user to be deleted, body: map}\n@returns(200) User was deleted\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 422: There was a problem with the delete such as a replacement is required or the replacement user was not found. Details will be provided in the response body., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/teams\n@desc Retrieve the user's team membership\n@required {user: any # The VictorOps user}\n@returns(200) Team details\n@errors {401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/policies/types/notifications\n@desc Get the available notification types\n@returns(200) All the available contact types\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/policies/types/contacts\n@desc Get the available contact types\n@returns(200) All the available contact types\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/policies/types/timeouts\n@desc Get the available timeout values\n@returns(200) All the available timeout types.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/profile/{username}/policies\n@desc Get the user's primary paging policy\n@required {username: any # Your username}\n@returns(200) All steps of the user's paging policy\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/profile/{username}/policies\n@desc Create a paging policy step\n@required {username: any # Your username, body: map}\n@returns(200) The created paging policy step\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/profile/{username}/policies/{step}\n@desc Get a paging policy step\n@required {username: any # Your username, step: any # Paging policy step}\n@returns(200) The paging policy step\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/profile/{username}/policies/{step}\n@desc Update a paging policy step\n@required {username: any # Your username, step: any # Paging policy step, body: map}\n@returns(200) The updated paging policy step\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/profile/{username}/policies/{step}\n@desc Create a rule for a paging policy step\n@required {username: any # Your username, step: any # Paging policy step, body: map}\n@returns(200) The created rule for the paging policy step\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/profile/{username}/policies/{step}/{rule}\n@desc Get a rule from a paging policy step\n@required {username: any # Your username, step: any # Paging policy step, rule: any # Rule for a paging policy step}\n@returns(200) The rule from the paging policy step\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/profile/{username}/policies/{step}/{rule}\n@desc Update a rule for a paging policy step\n@required {username: any # Your username, step: any # Paging policy step, rule: any # Rule for a paging policy step, body: map}\n@returns(200) The updated rule for the paging policy step\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/profile/{username}/policies/{step}/{rule}\n@desc Delete a rule from a paging policy step\n@required {username: any # Your username, step: any # Paging policy step, rule: any # Rule for a paging policy step}\n@returns(200) The deleted rule from the paging policy step\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v2/profile/{username}/policies\n@desc Get the user's paging policies\n@required {username: any # Your username}\n@returns(200) All steps of the user's paging policy\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/contact-methods\n@desc Get a list of all contact methods for a user\n@required {user: any # The VictorOps user ID}\n@returns(200) All available contact methods for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/contact-methods/devices\n@desc Get a list of all contact devices for a user\n@required {user: any # The VictorOps user ID}\n@returns(200) The list of contact devices for the user\n@errors {401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/contact-methods/devices/{contactId}\n@desc Get the indicated contact device for a user\n@required {user: any # The VictorOps user ID, contactId: any # The unique contact identifier}\n@returns(200) The list of contact devices for the user\n@errors {401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/user/{user}/contact-methods/devices/{contactId}\n@desc Update a contact device for a user\n@required {user: any # The VictorOps user ID, contactId: any # The unique contact identifier, body: map # The contact device}\n@returns(200) The list of contact devices for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/user/{user}/contact-methods/devices/{contactId}\n@desc Delete a contact device for a user\n@required {user: any # The VictorOps user ID, contactId: any # The unique contact identifier}\n@returns(200) Deleted contact device for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/contact-methods/emails\n@desc Get a list of all contact emails for a user\n@required {user: any # The VictorOps user ID}\n@returns(200) The list of contact emails for the user\n@errors {401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/user/{user}/contact-methods/emails\n@desc Create a contact emails for a user\n@required {user: any # The VictorOps user ID, body: map # The contact email}\n@returns(200) The list of contact emails for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/contact-methods/emails/{contactId}\n@desc Get the indicated contact email for a user\n@required {user: any # The VictorOps user ID, contactId: any # The unique contact identifier}\n@returns(200) The indicated contact email for the user\n@errors {401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/user/{user}/contact-methods/emails/{contactId}\n@desc Delete a contact email for a user\n@required {user: any # The VictorOps user ID, contactId: any # The unique contact identifier}\n@returns(200) Deleted contact email for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/contact-methods/phones\n@desc Get a list of all contact phones for a user\n@required {user: any # The VictorOps user ID}\n@returns(200) The list of contact phones for the user\n@errors {401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/user/{user}/contact-methods/phones\n@desc Create a contact phones for a user\n@required {user: any # The VictorOps user ID, body: map # The contact phone}\n@returns(200) The list of contact phones for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/contact-methods/phones/{contactId}\n@desc Get the indicated contact phone for a user\n@required {user: any # The VictorOps user ID, contactId: any # The unique contact identifier}\n@returns(200) The indicated contact phone for the user\n@errors {401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/user/{user}/contact-methods/phones/{contactId}\n@desc Delete a contact phone for a user\n@required {user: any # The VictorOps user ID, contactId: any # The unique contact identifier}\n@returns(200) Deleted contact phone for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/policies\n@desc Get a list of paging policies for a user\n@required {user: any # The VictorOps user ID}\n@returns(200) All configured paging policies for a user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/user/{user}/oncall/schedule\n@desc Get a user's on-call schedule\n@required {user: any # The VictorOps user ID}\n@optional {daysForward: any # Days to include in returned schedule (123 max), daysSkip: any # Days to skip before computing schedule to return (90 max), step: any # Step of escalation policy (3 max)}\n@returns(200) The on-call schedule for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v2/user/{user}/oncall/schedule\n@desc Get a user's on-call schedule\n@required {user: any # The VictorOps user ID}\n@optional {daysForward: any # Days to include in returned schedule (123 max), daysSkip: any # Days to skip before computing schedule to return (90 max), step: any # Step of escalation policy (3 max)}\n@returns(200) The on-call schedule for the user\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/team/{team}/oncall/schedule\n@desc Get a team's on-call schedule\n@required {team: any # The VictorOps team 'slug'}\n@optional {daysForward: any # Days to include in returned schedule (123 max), daysSkip: any # Days to skip before computing schedule to return (90 max), step: any # Step of escalation policy (3 max)}\n@returns(200) The on-call schedule for the team\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v2/team/{team}/oncall/schedule\n@desc Get a team's on-call schedule\n@required {team: any # The VictorOps team 'slug'}\n@optional {daysForward: any # Days to include in returned schedule (123 max), daysSkip: any # Days to skip before computing schedule to return (90 max), step: any # Step of escalation policy (3 max)}\n@returns(200) The on-call schedule for the team\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 429: Rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/oncall/current\n@desc Get an organization's on-call users\n@returns(200) All users and escalation policies currently on call\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endgroup\n\n@group api-reporting\n@endpoint GET /api-reporting/v1/team/{team}/oncall/log\n@desc A list of shift changes for a team\n@required {team: any # The VictorOps team 'slug'}\n@optional {start: any # Return shift changes occurring after this timestamp. The default is the start of the day at midnight. Specify the timestamp in ISO8601 format, end: any # Return shift changes occurring before this timestamp. The default is the end of the day at 11:59:59. Specify the timestamp in ISO8601 format, userName: any # The VictorOps user ID. Return shift changes occurring during the interval specified for this user. Without this parameter, all relevant users (with respect to the specified interval) are returned}\n@returns(200) The result of the take request\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team or user(s) not found, 500: Internal Server Error}\n\n@endgroup\n\n@group api-public\n@endpoint PATCH /api-public/v1/team/{team}/oncall/user\n@desc Create an on-call override (take on-call)\n@required {body: map # The take on-call payload, team: any # The VictorOps team 'slug'}\n@returns(200) The result of the take request\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team or user(s) not found, 500: Internal Server Error}\n\n@endpoint PATCH /api-public/v1/policies/{policy}/oncall/user\n@desc Create an on-call override (take on-call)\n@required {body: map # The take on-call payload, policy: any # The VictorOps policy 'slug'}\n@returns(200) The result of the take request\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team or user(s) not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/incidents/{incidentNumber}\n@desc Get a single incident\n@required {incidentNumber: any # The Victorops incident number}\n@returns(200) A single incident matching the provided incident number\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/incidents\n@desc Get current incident information\n@returns(200) The set of incidents.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/incidents\n@desc Create a new incident\n@required {body: map # The incident details}\n@returns(200) Information about the incident created\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint PATCH /api-public/v1/incidents/ack\n@desc Acknowledge an incident or list of incidents\n@required {body: map # Ack/Resolve payload}\n@returns(200) The result of each acknowledge incident action.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/incidents/reroute\n@desc Reroute one or more incidents to one or more new routable destinations.\n@required {body: map # The reroute rules}\n@returns(200) The created reroute object\n\n@endpoint PATCH /api-public/v1/incidents/resolve\n@desc Resolve an incident or list of incidents\n@required {body: map # Ack/Resolve payload}\n@returns(200) The result of each resolve incident action.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint PATCH /api-public/v1/incidents/byUser/ack\n@desc Acknowledge all incidents for which a user was paged.\n@required {body: map # Ack/Resolve payload}\n@returns(200) The result of each acknowledge incident action.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint PATCH /api-public/v1/incidents/byUser/resolve\n@desc Resolve all incidents for which a user was paged.\n@required {body: map # Ack/Resolve payload}\n@returns(200) The result of each resolve incident action.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/incidents/{incidentNumber}/notes\n@desc Get the notes associated with an incident\n@required {incidentNumber: any # The incident number}\n@returns(200) The set of notes associated with the incidentNumber.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/incidents/{incidentNumber}/notes\n@desc Create a new Note\n@required {body: map, incidentNumber: any # The incident number}\n@returns(200) Information about the note created\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/incidents/{incidentNumber}/notes/{noteName}\n@desc Update a Note\n@required {body: map, incidentNumber: any # The incident number, noteName: any # The html encoded name field of the note}\n@returns(200) Information about the note updated\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/incidents/{incidentNumber}/notes/{noteName}\n@desc Delete a Note\n@required {incidentNumber: any # The incident number, noteName: any # The html encoded name field of the note}\n@returns(200) Whether the note was successfully deleted\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/alerts/{uuid}\n@desc Retrieve alert details.\n@required {uuid: any # The VictorOps uuid of the alert}\n@returns(200) The alert, if found.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/org/routing-keys\n@desc List routing keys with associated teams\n@returns(200) The list of routing keys and associated teams\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/org/routing-keys\n@desc Create a new routing key\n@required {body: map}\n@returns(200) The created routing-key\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/overrides\n@desc List the scheduled overrides\n@returns(200) A list of scheduled overrides for your organization\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/overrides\n@desc Creates a new scheduled override\n@required {body: map}\n@returns(200) The created scheduled override\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/overrides/{publicId}\n@desc Get the specified scheduled override\n@required {publicId: any # The publicId of the scheduled override}\n@returns(200) The scheduled override\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/overrides/{publicId}\n@desc Deletes a scheduled override\n@required {publicId: any # The publicId of the scheduled override}\n@returns(200) Whether or not the delete was successful\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/overrides/{publicId}/assignments\n@desc Get the specified scheduled override\n@required {publicId: any # The publicId of the scheduled override}\n@returns(200) The assignments for a given scheduled override\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/overrides/{publicId}/assignments/{policySlug}\n@desc Get the specified scheduled override assignment\n@required {publicId: any # The publicId of the scheduled override, policySlug: any # The policySlug of the assignment}\n@returns(200) The assignment for the given publicId\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/overrides/{publicId}/assignments/{policySlug}\n@desc Update the scheduled override assignment\n@required {publicId: any # The publicId of the scheduled override, policySlug: any # The policySlug of the assignment, body: map # The policy and username we are assigning}\n@returns(200) The assignment for the given policySlug\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/overrides/{publicId}/assignments/{policySlug}\n@desc Delete the scheduled override assignment\n@required {publicId: any # The publicId of the scheduled override, policySlug: any # The policySlug of the assignment}\n@returns(200) The assignment that was deleted for the given scheduled override and policySlug\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 422: You have reached your user limit., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/teams/{team}/rotations\n@desc Get all rotation groups for a team\n@required {team: any # The uniquely identifying team slug for which to retrieve rotation groups}\n@returns(200) An object containing a list of all rotation groups that exist under the provided team A rotation is one rotation and all of its shifts. This is represented in the UI as a single rotation.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/teams/{team}/rotations\n@desc Create a rotation group\n@required {team: any # The team slug, body: map}\n@optional {skip: any # Number of weeks to skip for the on-call period preview, count: any # Number of weeks to show for the on-call period preview}\n@returns(200) The created rotation group with its shifts and on-call period details\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/teams/{team}/rotations/{groupId}\n@desc Delete a rotation group\n@required {team: any # The team slug, groupId: any # The rotation group ID}\n@returns(200) The rotation group was successfully deleted\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/teams/{team}/rotations/{groupId}/{shiftId}/scheduled\n@desc Get the scheduled user for a shift\n@required {team: any # The team slug, groupId: any # The rotation group ID, shiftId: any # The rotation shift ID}\n@returns(200) The currently scheduled user for the specified shift\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/teams/{team}/rotations/{groupId}/{shiftId}/scheduled\n@desc Set the scheduled user for a shift\n@required {team: any # The team slug, groupId: any # The rotation group ID, shiftId: any # The rotation shift ID, body: map}\n@returns(200) The scheduled user after the update\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v2/team/{team}/rotations\n@desc Get all rotations and some rotation details for a team\n@required {team: any # The uniquely identifying team slug for which to retrieve rotations}\n@returns(200) An object containing a list of all rotations that exist under the provided team\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/webhooks\n@desc Get all of your organization's webhooks\n@returns(200) An object containing a list of all webhooks existing in the organization This references the webhooks created in the \"Webhooks\" integration.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/policies\n@desc Get a list of escalation policy info\n@optional {filter: any # An escalation policy name to be used for filtering the results. Note: If this parameter is present, it must be at least three (3) characters long}\n@returns(200) A list of escalation policy info objects, each of which contain a summary of an escalation policy and a summary for the team associated with that escalation policy.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/policies\n@desc Create an escalation policy\n@required {body: map # The request body needed to create an escalation policy}\n@returns(200) The newly created escalation policy\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/policies/{policy}\n@desc Get a specific escalation policy\n@required {policy: any # The uniquely identifying escalation policy slug.  Thus slug is in the format `pol-[\\w\\d]{16}`}\n@returns(200) The escalation policy matching the provided slug\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/policies/{policy}\n@desc Delete a specified escalation policy\n@required {policy: any # The uniquely identifying escalation policy slug. The policy slug is in the format `pol-[\\w\\d]{16}`}\n@returns(200) The escalation policy was deleted\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endgroup\n\n@group api-reporting\n@endpoint GET /api-reporting/v2/incidents\n@desc Get/search incident history\n@optional {offset: any # The offset within the set of matching incidents, limit: any # The maximum number of matching incidents to return (100 max), entityId: any # The entity ID involved  This is the unique identifier for the entity causing the incident., incidentNumber: any # The incident number as shown in VictorOps Multiple values and ranges are allowed: 4,5,20:50, startedAfter: any # Return incidents started after this timestamp Specify the timestamp in ISO8601 format, startedBefore: any # Find incidents started before this timestamp  Specify the timestamp in ISO8601 format, host: any # The host involved in the incident Multiple values can be separated with commas., service: any # The service involved in the incident (if any) Multiple values can be separated with commas., currentPhase: any # The current phase of the incident \"resolved\", \"triggered\" or \"acknowledged\". Multiple values can be separated with commas. By default, response contains only \"resolved\" incidents, routingKey: any # The original routing of the incident}\n@returns(200) The list of incidents matching the request filters\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 500: Internal Server Error}\n\n@endgroup\n\n@group api-public\n@endpoint POST /api-public/v1/team\n@desc Add a team\n@required {body: map # The team information}\n@returns(200) Some details about the team that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: Team name or email is unavailable, or you have reached your team limit., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/team\n@desc List teams\n@returns(200) A list of teams for your organization\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: You have reached your team limit., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/team/{team}\n@desc Retrieve information for a team\n@required {team: any # The VictorOps team to fetch}\n@returns(200) Some details about the team that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: Team name or email is unavailable, or you have reached your team limit., 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/team/{team}\n@desc Update a team\n@required {team: any # The VictorOps team to be updated, body: map # The team information}\n@returns(200) Some details about the team that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: Team name or email is unavailable, or you have reached your team limit., 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/team/{team}\n@desc Remove a team\n@required {team: any # The VictorOps team to be deleted}\n@returns(200) Team was deleted\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: There was a problem with the delete such as the replacement team was not found., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/team/{team}/policies\n@desc Retrieve a list of escalation policies for a team\n@required {team: any # The VictorOps team to fetch}\n@returns(200) The escalation policy list. This does not include details about the actual notification steps of the policy.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: Team name or email is unavailable, or you have reached your team limit., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/team/{team}/admins\n@desc Retrieve a list of team admins for a team\n@required {team: any # The VictorOps team}\n@returns(200) Some details about the team that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/team/{team}/members\n@desc Retrieve a list of members for a team\n@required {team: any # The VictorOps team to fetch}\n@returns(200) Some details about the team that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: Team name or email is unavailable, or you have reached your team limit., 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/team/{team}/members\n@desc Add a team member\n@required {team: any # The VictorOps team to fetch, body: map}\n@returns(200) Some details about the team that was added\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: Team name or email is unavailable, or you have reached your team limit., 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/team/{team}/members/{user}\n@desc Remove a team member\n@required {team: any # The VictorOps team to be removed from, user: any # The team member username to be removed, body: map # The user information}\n@returns(200) User was successfully removed from team\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Team not found, 422: There was a problem with the delete such as the replacement team member was not found., 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/maintenancemode\n@desc Get an organization's current maintenance mode state\n@returns(200) maintenance mode state\n@errors {403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/maintenancemode/start\n@desc Start maintenance mode for routing keys\n@required {body: map # the definition of the maintenance mode you want to start}\n@returns(200) maintenance mode state\n@errors {403: Authentication failed or rate-limit reached, 409: You 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, 420: You have reached the limit of allowed active maintenance modes, 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/maintenancemode/{maintenancemodeid}/end\n@desc End maintenance mode for routing keys\n@required {maintenancemodeid: any # The id of the maintenance mode found in the active maintenance mode object}\n@returns(200) maintenance mode state\n@errors {403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/chat\n@desc Send a chat message into VictorOps\n@required {body: map}\n@returns(200) A chat message was successfully created.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/stakeholders/sendMessage\n@desc Sends a stakeholder message to the recipients. Recipients can either be User/team or both.\n@required {body: map # The request body needed to send Stakeholder message.}\n@returns(200) Status success.\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: Path not found, 429: Rate-limit reached, 500: Internal Server Error}\n\n@endpoint GET /api-public/v1/alertRules\n@desc Get all alert rules\n@returns(200) The alert rules of an organization\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 500: Internal Server Error}\n\n@endpoint POST /api-public/v1/alertRules\n@desc Create alert rule\n@required {body: map # The request body needed to create/update an alert rule with annotations}\n@returns(200) The created alert rule\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint PUT /api-public/v1/alertRules/{ruleId}\n@desc Update alert rule\n@required {body: map # The request body needed to create/update an alert rule with annotations, ruleId: any # Alert rule id}\n@returns(200) The updated alert rule\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endpoint DELETE /api-public/v1/alertRules/{ruleId}\n@desc Delete alert rule\n@required {ruleId: any # Alert rule id}\n@returns(200) The deleted alert rule id\n@errors {400: Problem with the request arguments.  The response payload may include an error message., 401: Authentication parameters missing, 403: Authentication failed or rate-limit reached, 404: User not found, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}}