Skip to content

Latest commit

 

History

History
688 lines (654 loc) · 48.9 KB

README.md

File metadata and controls

688 lines (654 loc) · 48.9 KB
Raw

opsgenie_swagger

OpsGenie OpenAPI Specification

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2.0.0
  • Package version: 1.0.7
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/iksaif/opsgenie_swagger.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/iksaif/opsgenie_swagger.git)

Then import the package:

import opsgenie_swagger

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import opsgenie_swagger

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import opsgenie_swagger
from opsgenie_swagger.rest import ApiException
from pprint import pprint

# Configure API key authorization: GenieKey
config = opsgenie_swagger.configuration.Configuration()
config.api_key['Authorization'] = 'YOUR_API_KEY'
config.api_key_prefix['Authorization'] = 'GenieKey'

api_instance = opsgenie_swagger.AccountApi()

try:
    # Get Account Info
    api_response = api_instance.get_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->get_info: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.opsgenie.com

Class Method HTTP request Description
AccountApi get_info GET /v2/account Get Account Info
AlertApi acknowledge_alert POST /v2/alerts/{identifier}/acknowledge Acknowledge Alert
AlertApi add_attachment POST /v2/alerts/{identifier}/attachments Add Alert Attachment
AlertApi add_details POST /v2/alerts/{identifier}/details Add Details
AlertApi add_note POST /v2/alerts/{identifier}/notes Add Note
AlertApi add_responder POST /v2/alerts/{identifier}/responders Add Responder
AlertApi add_tags POST /v2/alerts/{identifier}/tags Add Tags
AlertApi add_team POST /v2/alerts/{identifier}/teams Add Team
AlertApi assign_alert POST /v2/alerts/{identifier}/assign Assign Alert
AlertApi close_alert POST /v2/alerts/{identifier}/close Close Alert
AlertApi create_alert POST /v2/alerts Create Alert
AlertApi create_saved_searches POST /v2/alerts/saved-searches Create Saved Search
AlertApi delete_alert DELETE /v2/alerts/{identifier} Delete Alert
AlertApi delete_saved_search DELETE /v2/alerts/saved-searches/{identifier} Delete Saved Search
AlertApi escalate_alert POST /v2/alerts/{identifier}/escalate Escalate Alert
AlertApi execute_custom_alert_action POST /v2/alerts/{identifier}/actions/{actionName} Custom Alert Action
AlertApi get_alert GET /v2/alerts/{identifier} Get Alert
AlertApi get_attachment GET /v2/alerts/{identifier}/attachments/{attachmentId} Get Alert Attachment
AlertApi get_request_status GET /v2/alerts/requests/{requestId} Get Request Status of Alert
AlertApi get_saved_search GET /v2/alerts/saved-searches/{identifier} Get Saved Search
AlertApi list_alerts GET /v2/alerts List Alerts
AlertApi list_attachments GET /v2/alerts/{identifier}/attachments List Alert Attachments
AlertApi list_logs GET /v2/alerts/{identifier}/logs List Alert Logs
AlertApi list_notes GET /v2/alerts/{identifier}/notes List Alert Notes
AlertApi list_recipients GET /v2/alerts/{identifier}/recipients List Alert Recipients
AlertApi list_saved_searches GET /v2/alerts/saved-searches Lists Saved Searches
AlertApi remove_attachment DELETE /v2/alerts/{identifier}/attachments/{attachmentId} Remove Alert Attachment
AlertApi remove_details DELETE /v2/alerts/{identifier}/details Remove Details
AlertApi remove_tags DELETE /v2/alerts/{identifier}/tags Remove Tags
AlertApi snooze_alert POST /v2/alerts/{identifier}/snooze Snooze Alert
AlertApi un_acknowledge_alert POST /v2/alerts/{identifier}/unacknowledge UnAcknowledge Alert
ContactApi create_contact POST /v2/users/{identifier}/contacts Create Contact
ContactApi delete_contact DELETE /v2/users/{identifier}/contacts/{contactId} Delete Contact
ContactApi disable_contact POST /v2/users/{identifier}/contacts/{contactId}/disable Disable Contact
ContactApi enable_contact POST /v2/users/{identifier}/contacts/{contactId}/enable Enable Contact
ContactApi get_contact GET /v2/users/{identifier}/contacts/{contactId} Get Contact
ContactApi list_contacts GET /v2/users/{identifier}/contacts List Contacts
ContactApi update_contact PATCH /v2/users/{identifier}/contacts/{contactId} Update Contact (Partial)
CustomUserRoleApi create_custom_user_role POST /v2/roles Create Custom User Role
CustomUserRoleApi delete_custom_user_role DELETE /v2/roles/{identifier} Delete Custom User Role
CustomUserRoleApi get_custom_user_role GET /v2/roles/{identifier} Get Custom User Role
CustomUserRoleApi list_custom_user_roles GET /v2/roles List Custom User Roles
CustomUserRoleApi update_custom_user_role PUT /v2/roles/{identifier} Update Custom User Role
DeprecatedPolicyApi change_alert_policy_order POST /v1/policies/{policyId}/change-order Change Alert Policy Order
DeprecatedPolicyApi create_alert_policy POST /v1/policies Create Alert Policy
DeprecatedPolicyApi delete_alert_policy DELETE /v1/policies/{policyId} Delete Alert Policy
DeprecatedPolicyApi disable_alert_policy POST /v1/policies/{policyId}/disable Disable Alert Policy
DeprecatedPolicyApi enable_alert_policy POST /v1/policies/{policyId}/enable Enable Alert Policy
DeprecatedPolicyApi get_alert_policy GET /v1/policies/{policyId} Get Alert Policy
DeprecatedPolicyApi list_alert_policies GET /v1/policies List Alert Policies
DeprecatedPolicyApi update_alert_policy PUT /v1/policies/{policyId} Update Alert Policy
EscalationApi create_escalation POST /v2/escalations Create Escalation
EscalationApi delete_escalation DELETE /v2/escalations/{identifier} Delete Escalation
EscalationApi get_escalation GET /v2/escalations/{identifier} Get Escalation
EscalationApi list_escalations GET /v2/escalations List Escalations
EscalationApi update_escalation PATCH /v2/escalations/{identifier} Update Escalation (Partial)
ForwardingRuleApi create_forwarding_rule POST /v2/forwarding-rules Create Forwarding Rule
ForwardingRuleApi delete_forwarding_rule DELETE /v2/forwarding-rules/{identifier} Delete Forwarding Rule
ForwardingRuleApi get_forwarding_rule GET /v2/forwarding-rules/{identifier} Get Forwarding Rule
ForwardingRuleApi list_forwarding_rules GET /v2/forwarding-rules List Forwarding Rules
ForwardingRuleApi update_forwarding_rule PUT /v2/forwarding-rules/{identifier} Update Forwarding Rule
HeartbeatApi create_heartbeat POST /v2/heartbeats Create Heartbeat
HeartbeatApi delete_heartbeat DELETE /v2/heartbeats/{name} Delete Heartbeat
HeartbeatApi disable_heartbeat POST /v2/heartbeats/{name}/disable Disable Heartbeat
HeartbeatApi enable_heartbeat POST /v2/heartbeats/{name}/enable Enable Heartbeat
HeartbeatApi get_heartbeat GET /v2/heartbeats/{name} Get Heartbeat
HeartbeatApi ping GET /v2/heartbeats/{name}/ping Ping Heartbeat
HeartbeatApi update_heartbeat PATCH /v2/heartbeats/{name} Update Heartbeat (Partial)
IntegrationApi authenticate_integration POST /v2/integrations/authenticate Authenticate Integration
IntegrationApi create_integration POST /v2/integrations Create Integration
IntegrationApi delete_integration DELETE /v2/integrations/{id} Delete Integration
IntegrationApi disable_integration POST /v2/integrations/{id}/disable Disable Integration
IntegrationApi enable_integration POST /v2/integrations/{id}/enable Enable Integration
IntegrationApi get_integration GET /v2/integrations/{id} Get Integration
IntegrationApi list_integrations GET /v2/integrations List Integrations
IntegrationApi update_integration PUT /v2/integrations/{id} Update Integration
IntegrationActionApi create_integration_action POST /v2/integrations/{id}/actions Create Integration Action
IntegrationActionApi list_integration_actions GET /v2/integrations/{id}/actions List Integration Actions
IntegrationActionApi update_integration_actions PUT /v2/integrations/{id}/actions Update Integration Actions
MaintenanceApi cancel_maintenance POST /v1/maintenance/{id}/cancel Cancel Maintenance
MaintenanceApi create_maintenance POST /v1/maintenance Create Maintenance
MaintenanceApi delete_maintenance DELETE /v1/maintenance/{id} Delete Maintenance
MaintenanceApi get_maintenance GET /v1/maintenance/{id} Get Maintenance
MaintenanceApi list_maintenance GET /v1/maintenance List Maintenance
MaintenanceApi update_maintenance PUT /v1/maintenance/{id} Update Maintenance
NotificationRuleApi change_notification_rule_order POST /v2/users/{identifier}/notification-rules/{ruleId}/change-order Change order of Notification Rule
NotificationRuleApi create_notification_rule POST /v2/users/{identifier}/notification-rules Create Notification Rule
NotificationRuleApi delete_notification_rule DELETE /v2/users/{identifier}/notification-rules/{ruleId} Delete Notification Rule
NotificationRuleApi disable_notification_rule POST /v2/users/{identifier}/notification-rules/{ruleId}/disable Disable Notification Rule
NotificationRuleApi enable_notification_rule POST /v2/users/{identifier}/notification-rules/{ruleId}/enable Enable Notification Rule
NotificationRuleApi get_notification_rule GET /v2/users/{identifier}/notification-rules/{ruleId} Get Notification Rule
NotificationRuleApi list_notification_rules GET /v2/users/{identifier}/notification-rules List Notification Rules
NotificationRuleApi update_notification_rule PATCH /v2/users/{identifier}/notification-rules/{ruleId} Update Notification Rule (Partial)
NotificationRuleStepApi create_notification_rule_step POST /v2/users/{identifier}/notification-rules/{ruleId}/steps Create Notification Rule Step
NotificationRuleStepApi delete_notification_rule_step DELETE /v2/users/{identifier}/notification-rules/{ruleId}/steps/{id} Delete Notification Rule Step
NotificationRuleStepApi disable_notification_rule_step POST /v2/users/{identifier}/notification-rules/{ruleId}/steps/{id}/disable Disable Notification Rule Step
NotificationRuleStepApi enable_notification_rule_step POST /v2/users/{identifier}/notification-rules/{ruleId}/steps/{id}/enable Enable Notification Rule Step
NotificationRuleStepApi get_notification_rule_step GET /v2/users/{identifier}/notification-rules/{ruleId}/steps/{id} Get Notification Rule Step
NotificationRuleStepApi list_notification_rule_steps GET /v2/users/{identifier}/notification-rules/{ruleId}/steps List Notification Rule Steps
NotificationRuleStepApi update_notification_rule_step PATCH /v2/users/{identifier}/notification-rules/{ruleId}/steps/{id} Update Notification Rule Step (Partial)
PolicyApi change_policy_order POST /v2/policies/{policyId}/change-order Change Policy Order
PolicyApi create_policy POST /v2/policies Create Policy
PolicyApi delete_policy DELETE /v2/policies/{policyId} Delete Policy
PolicyApi disable_policy POST /v2/policies/{policyId}/disable Disable Policy
PolicyApi enable_policy POST /v2/policies/{policyId}/enable Enable Policy
PolicyApi get_policy GET /v2/policies/{policyId} Get Policy
PolicyApi list_alert_policies GET /v2/policies/alert List Alert Policies
PolicyApi list_notification_policies GET /v2/policies/notification List Notification Policies
PolicyApi update_policy PUT /v2/policies/{policyId} Update Policy
ScheduleApi create_schedule POST /v2/schedules Create Schedule
ScheduleApi delete_schedule DELETE /v2/schedules/{identifier} Delete Schedule
ScheduleApi export_schedule GET /v2/schedules/{identifier}.ics Export Schedule
ScheduleApi get_schedule GET /v2/schedules/{identifier} Get Schedule
ScheduleApi get_schedule_timeline GET /v2/schedules/{identifier}/timeline Get Schedule Timeline
ScheduleApi list_schedules GET /v2/schedules List Schedules
ScheduleApi update_schedule PATCH /v2/schedules/{identifier} Update Schedule (Partial)
ScheduleOverrideApi create_schedule_override POST /v2/schedules/{identifier}/overrides Create Schedule Override
ScheduleOverrideApi delete_schedule_override DELETE /v2/schedules/{identifier}/overrides/{alias} Delete Schedule Override
ScheduleOverrideApi get_schedule_override GET /v2/schedules/{identifier}/overrides/{alias} Get Schedule Override
ScheduleOverrideApi list_schedule_override GET /v2/schedules/{identifier}/overrides List Schedule Overrides
ScheduleOverrideApi update_schedule_override PUT /v2/schedules/{identifier}/overrides/{alias} Update Schedule Override
ScheduleRotationApi create_schedule_rotation POST /v2/schedules/{identifier}/rotations Create Schedule Rotation
ScheduleRotationApi delete_schedule_rotation DELETE /v2/schedules/{identifier}/rotations/{id} Delete Schedule Rotation
ScheduleRotationApi get_schedule_rotation GET /v2/schedules/{identifier}/rotations/{id} Get Schedule Rotation
ScheduleRotationApi list_schedule_rotations GET /v2/schedules/{identifier}/rotations List Schedule Rotations
ScheduleRotationApi update_schedule_rotation PATCH /v2/schedules/{identifier}/rotations/{id} Update Schedule Rotation (Partial)
TeamApi create_team POST /v2/teams Create Team
TeamApi delete_team DELETE /v2/teams/{identifier} Delete Team
TeamApi get_team GET /v2/teams/{identifier} Get Team
TeamApi list_team_logs GET /v2/teams/{identifier}/logs List Team Logs
TeamApi list_teams GET /v2/teams List Teams
TeamApi update_team PATCH /v2/teams/{identifier} Update Team (Partial)
TeamMemberApi add_team_member POST /v2/teams/{identifier}/members Add Team Member
TeamMemberApi delete_team_member DELETE /v2/teams/{identifier}/members/{memberIdentifier} Delete Team Member
TeamRoleApi create_team_role POST /v2/teams/{identifier}/roles Create Team Role
TeamRoleApi delete_team_role DELETE /v2/teams/{identifier}/roles/{teamRoleIdentifier} Delete Team Role
TeamRoleApi get_team_role GET /v2/teams/{identifier}/roles/{teamRoleIdentifier} Get Team Role
TeamRoleApi list_team_roles GET /v2/teams/{identifier}/roles List Team Roles
TeamRoleApi update_team_role PATCH /v2/teams/{identifier}/roles/{teamRoleIdentifier} Update Team Role (Partial)
TeamRoutingRuleApi change_team_routing_rule_order POST /v2/teams/{identifier}/routing-rules/{id}/change-order Change Team Routing Rule Order
TeamRoutingRuleApi create_team_routing_rule POST /v2/teams/{identifier}/routing-rules Create Team Routing Rule
TeamRoutingRuleApi delete_team_routing_rule DELETE /v2/teams/{identifier}/routing-rules/{id} Delete Team Routing Rule
TeamRoutingRuleApi get_team_routing_rule GET /v2/teams/{identifier}/routing-rules/{id} Get Team Routing Rule
TeamRoutingRuleApi list_team_routing_rules GET /v2/teams/{identifier}/routing-rules List Team Routing Rules
TeamRoutingRuleApi update_team_routing_rule PATCH /v2/teams/{identifier}/routing-rules/{id} Update Team Routing Rule (Partial)
UserApi create_user POST /v2/users Create User
UserApi delete_user DELETE /v2/users/{identifier} Delete User
UserApi get_user GET /v2/users/{identifier} Get User
UserApi list_user_escalations GET /v2/users/{identifier}/escalations List User Escalations
UserApi list_user_forwarding_rules GET /v2/users/{identifier}/forwarding-rules List User Forwarding Rules
UserApi list_user_schedules GET /v2/users/{identifier}/schedules List User Schedules
UserApi list_user_teams GET /v2/users/{identifier}/teams List User Teams
UserApi list_users GET /v2/users List users
UserApi update_user PATCH /v2/users/{identifier} Update User (Partial)
WhoIsOnCallApi export_on_call_user GET /v2/schedules/on-calls/{identifier}.ics Export On-Call User
WhoIsOnCallApi get_next_on_calls GET /v2/schedules/{identifier}/next-on-calls Get Next On Calls
WhoIsOnCallApi get_on_calls GET /v2/schedules/{identifier}/on-calls Get On Calls
WhoIsOnCallApi list_on_calls GET /v2/schedules/on-calls List On Calls

Documentation For Models

Documentation For Authorization

GenieKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author